• <ins id="pjuwb"></ins>
    <blockquote id="pjuwb"><pre id="pjuwb"></pre></blockquote>
    <noscript id="pjuwb"></noscript>
          <sup id="pjuwb"><pre id="pjuwb"></pre></sup>
            <dd id="pjuwb"></dd>
            <abbr id="pjuwb"></abbr>

            C++ Programmer's Cookbook

            {C++ 基礎(chǔ)} {C++ 高級} {C#界面,C++核心算法} {設(shè)計模式} {C#基礎(chǔ)}

            XML Comments in C#

            Author: James Foster Date Posted: 09/02/2001 .NET Version: 1.0.3705
            Many of you have heard of JavaDoc, a feature of Java that automatically generates HTML documentation for your code. C#, and the C# compiler, is capable of a similar function, yet produces XML instead of directly producing HTML. This makes the documentation much more flexible.

            Commenting Syntax
            To use the XML commenting features of C#, you begin by commenting your source code using the special comment syntax, /// (three slashes). After the slashes you use one of the predefined tags for documentation comments, or embed your own. Your custom xml tags will carry over into the result XML documentation.

            Predefined TagUsed for
            <c>a way to indicate that text within a description should be marked as code
            <code>a way to indicate multiple lines as code
            <example>lets you specify an example of how to use a method or other library member
            <exception>lets you document an exception class
            <include>lets you refer to comments in another file, using XPath syntax, that describe the types and members in your source code.
            <list>Used to insert a list into the documentation file
            <para>Used to insert a paragraph into the documentation file
            <param>Describes a parameter
            <paramref>gives you a way to indicate that a word is a parameter
            <permission>lets you document access permissions
            <remarks>where you can specify overview information about the type
            <returns>describe the return value of a method
            <see>lets you specify a link
            <seealso>lets you specify the text that you might want to appear in a See Also section
            <summary>used for a general description
            <value>lets you describe a property
            Example
            The following example adds comments to our introductory HelloWorld console application.
            using System;

            namespace HelloWorld
            {
            ????/// <summary>
            ????/// Sample Hello World in C#
            ????/// </summary>
            ????publicclass HelloWorld
            ????{
            ????????/// <summary>
            ????????/// Console Application Entry Point
            ????????/// <param name="args">Command Line Arguments</param>
            ????????/// <returns>Status code of 0 on successful run</returns>
            ????????/// </summary>
            ????????publicstaticint Main(string[]args)
            ????????{
            ????????????System.Console.WriteLine("HelloWorld");
            ????????????stringname= System.Console.ReadLine();

            ????????????return(0);
            ????????}
            ????}
            }

            To get the resulting XML Documentation file, we call the csc compiler with the /doc option.

            csc /doc:HelloWorld.xml helloworld.cs 或修改工程的property.build.output.xmldocument.(在2005中)


            HTML Web Pages
            You may be asking yourself: how do I get nicely formatted web pages? Well, you could write your own XSL to transform the XML documentation file, or you could use Visual Studio.NET. By using the Tools -> Build Comment Web Pages option, you can get a set of html files detailing your entire project or solution. Here is a screen shot by building web pages for our HelloWorld example:


            But if you want to create easy-to-use, helpful, cross-referenced and attractive documentation, then I can strongly recommend the free, open source tool NDoc. The screenshot below is taken from a compiled help file produced from NDoc and is an example of the quality it can produce.



            可以把xml制作chm的工具
            NANT? 下載:http://nant.sourceforge.net/
            NDOC? 下載:http://ndoc.sourceforge.net/

            posted on 2006-04-13 14:02 夢在天涯 閱讀(830) 評論(1)  編輯 收藏 引用 所屬分類: C#/.NET

            評論

            # re: XML Comments in C# 2006-04-30 16:25 夢在天涯

            很好用的啊,但是好像沒有最新的支持.net 2.0的啊!  回復(fù)  更多評論   

            公告

            EMail:itech001#126.com

            導(dǎo)航

            統(tǒng)計

            • 隨筆 - 461
            • 文章 - 4
            • 評論 - 746
            • 引用 - 0

            常用鏈接

            隨筆分類

            隨筆檔案

            收藏夾

            Blogs

            c#(csharp)

            C++(cpp)

            Enlish

            Forums(bbs)

            My self

            Often go

            Useful Webs

            Xml/Uml/html

            搜索

            •  

            積分與排名

            • 積分 - 1808097
            • 排名 - 5

            最新評論

            閱讀排行榜

            国产精品久久久天天影视| 久久久女人与动物群交毛片| 成人国内精品久久久久影院VR| 伊人色综合久久| 日产久久强奸免费的看| 五月丁香综合激情六月久久| 久久99精品久久久久久久久久| 精品久久香蕉国产线看观看亚洲| 久久高清一级毛片| 日韩AV无码久久一区二区| 99久久精品免费看国产免费| 久久久SS麻豆欧美国产日韩| 国产精品久久久久9999| 少妇人妻综合久久中文字幕| 韩国免费A级毛片久久| 亚洲精品97久久中文字幕无码| 成人资源影音先锋久久资源网| 色狠狠久久综合网| 久久精品国产99久久久香蕉| 久久久久久久久久久久中文字幕| 久久国产精品波多野结衣AV| 高清免费久久午夜精品| 97久久国产综合精品女不卡| 久久精品国产只有精品66 | 欧美麻豆久久久久久中文| 亚洲国产精品无码久久久蜜芽| 99久久精品国产一区二区三区| 久久久无码精品亚洲日韩按摩| 久久91精品国产91久| 久久黄视频| 久久久久99精品成人片牛牛影视| 人妻精品久久久久中文字幕69| 国产精品久久久久久久久久影院 | 久久久久亚洲AV成人网人人网站| 九九精品99久久久香蕉| 亚洲AV无码久久精品蜜桃| 性高湖久久久久久久久| 久久久久久综合网天天| 伊人久久大香线蕉综合网站| 日本久久中文字幕| 久久精品青青草原伊人|