• <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

            搜索

            •  

            積分與排名

            • 積分 - 1807602
            • 排名 - 5

            最新評論

            閱讀排行榜

            色妞色综合久久夜夜| 91性高湖久久久久| 久久久久亚洲爆乳少妇无| 丁香五月网久久综合| 精品国产VA久久久久久久冰| 久久人人爽人人爽人人片av高请| 亚洲AV无码一区东京热久久| 色诱久久av| 亚洲精品无码久久久久久| 精品国际久久久久999波多野| AV无码久久久久不卡蜜桃| 国产成人精品久久亚洲高清不卡| 国产亚洲精久久久久久无码AV| 久久人人爽人人爽人人片AV麻豆 | 久久精品视频一| 一本大道久久东京热无码AV| 国内高清久久久久久| 久久99免费视频| 久久久国产亚洲精品| 久久国产精品-国产精品| 亚洲人成网站999久久久综合 | 久久久久高潮综合影院| 99国产欧美精品久久久蜜芽| 久久99精品国产99久久6| 亚洲国产天堂久久综合| 久久综合欧美成人| 伊人久久无码精品中文字幕| 美女写真久久影院| 色综合久久中文字幕无码| 久久久噜噜噜久久| 久久亚洲国产欧洲精品一| 狠狠色噜噜色狠狠狠综合久久| 国产69精品久久久久99| 狼狼综合久久久久综合网| 国产精品一区二区久久精品涩爱 | 77777亚洲午夜久久多喷| 亚洲欧美成人久久综合中文网| 久久电影网一区| 久久精品国产亚洲AV久| 日韩精品久久久久久久电影| 久久精品中文字幕一区|