• <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 夢在天涯 閱讀(831) 評論(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

            搜索

            •  

            積分與排名

            • 積分 - 1808403
            • 排名 - 5

            最新評論

            閱讀排行榜

            久久久久亚洲AV成人网| 亚洲精品美女久久久久99| 欧美亚洲另类久久综合| 久久精品国产99国产精品| 一级女性全黄久久生活片免费| 狼狼综合久久久久综合网| 国产精品亚洲美女久久久| 东方aⅴ免费观看久久av| 国産精品久久久久久久| 久久亚洲中文字幕精品一区| 狠狠色婷婷综合天天久久丁香| 久久这里有精品| 国产巨作麻豆欧美亚洲综合久久| 亚洲午夜福利精品久久| 国产一区二区精品久久岳| 午夜精品久久久久久影视777| 久久久无码精品亚洲日韩按摩 | 久久国产精品免费| 久久久久久久人妻无码中文字幕爆 | 99久久国产综合精品女同图片| 久久精品国产影库免费看| 欧美噜噜久久久XXX| 精品久久久久久久久免费影院| 久久九九亚洲精品| 国产精品岛国久久久久| 蜜臀av性久久久久蜜臀aⅴ| 久久人人添人人爽添人人片牛牛| 久久精品二区| 日韩久久无码免费毛片软件| 91亚洲国产成人久久精品网址| 2021久久精品国产99国产精品 | 欧美一区二区精品久久| 好久久免费视频高清| 久久国产精品无码一区二区三区| 少妇精品久久久一区二区三区 | 国产精品热久久无码av| 秋霞久久国产精品电影院| 99久久免费只有精品国产| 精品久久久久久国产牛牛app| 久久久久国产精品三级网| 欧美久久一区二区三区|