This class has xml documentation

You can add documentation in remarks

And the remarks can contain paragraphs

        public void Method()
        {
            // 1. Place the caret on the Documented class name and invoke QuickDoc
            //    Click the "Go to" hyperlink to take the caret to the definition of Documented
            //    Click the "RelatedClass" see-also hyperlink to read the xml documentation for RelatedClass
            var documented = new Documented();

            // 2. Place the caret on the DocumentedMethod method and invoke QuickDoc
            //    Navigate the hyperlinks for parameter and return types
            documented.DocumentedMethod("hello", true);
        }
        public void Method()
        {
            // 1. 选中Documented, 执行Show Quick Documentation
            //    点击Go to链接, 可以转到Documented类的定义
            //    点击See Also下的RelatedClass链接, 会显示RelatedClass的快速文档
            var documented = new Documented();

            // 2. 选中DocumentedMethod, 执行Show Quick Documentation
            //    你可以点击参数类型和返回类型的链接
            documented.DocumentedMethod("hello", true);
        }
示例#3
0
        public void Method()
        {
            // 1. Place the caret on the Documented class name and invoke QuickDoc
            //    Click the "Go to" hyperlink to take the caret to the definition of Documented
            //    Click the "RelatedClass" see-also hyperlink to read the xml documentation for RelatedClass
            var documented = new Documented();

            // 2. Place the caret on the DocumentedMethod method and invoke QuickDoc
            //    Navigate the hyperlinks for parameter and return types
            documented.DocumentedMethod("hello", true);
        }