青青草原综合久久大伊人导航_色综合久久天天综合_日日噜噜夜夜狠狠久久丁香五月_热久久这里只有精品

C++ Programmer's Cookbook

{C++ 基礎} {C++ 高級} {C#界面,C++核心算法} {設計模式} {C#基礎}

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 夢在天涯 閱讀(836) 評論(1)  編輯 收藏 引用 所屬分類: C#/.NET

評論

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

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

公告

EMail:itech001#126.com

導航

統計

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

常用鏈接

隨筆分類

隨筆檔案

收藏夾

Blogs

c#(csharp)

C++(cpp)

Enlish

Forums(bbs)

My self

Often go

Useful Webs

Xml/Uml/html

搜索

  •  

積分與排名

  • 積分 - 1811733
  • 排名 - 5

最新評論

閱讀排行榜

青青草原综合久久大伊人导航_色综合久久天天综合_日日噜噜夜夜狠狠久久丁香五月_热久久这里只有精品
  • <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>
              亚洲一区三区视频在线观看| 亚洲一区二区在线免费观看视频 | 蜜桃av噜噜一区| 国内在线观看一区二区三区| 久久久久久九九九九| 久久精品国产99国产精品澳门| 国产一区二区日韩| 亚洲福利视频网站| 欧美特黄a级高清免费大片a级| 欧美**人妖| 一级成人国产| 欧美一区二区三区成人| 韩国免费一区| 99精品免费视频| 国产色视频一区| 91久久精品国产91性色tv| 欧美日韩一区在线观看| 欧美综合国产| 欧美大片91| 新67194成人永久网站| 久久精品欧洲| 一区二区欧美在线| 欧美一级在线视频| 亚洲另类一区二区| 亚洲一区在线观看视频 | 欧美成人黄色小视频| 亚洲综合电影| 欧美+日本+国产+在线a∨观看| 亚洲欧美日韩一区| 欧美国产第一页| 久久精品日韩| 欧美日韩综合一区| 欧美第一黄色网| 国产一区二区三区最好精华液| 亚洲欧洲日韩在线| 一区在线影院| 亚洲欧美视频在线| 亚洲视频一区| 欧美二区视频| 免费看av成人| 国产一区二区视频在线观看 | 久久精品国产欧美激情| 欧美区高清在线| 欧美黄色网络| 在线观看日韩专区| 午夜久久美女| 欧美一区二区三区男人的天堂| 欧美另类女人| 亚洲日本成人在线观看| 91久久线看在观草草青青| 欧美在线观看www| 欧美专区日韩视频| 国产精品久久久久久av下载红粉| 亚洲国产精品精华液2区45 | 欧美日韩亚洲一区二区三区四区 | 午夜精品国产精品大乳美女| 欧美日韩亚洲一区二区| 亚洲精品免费在线播放| 亚洲免费成人av| 欧美激情偷拍| 亚洲人成亚洲人成在线观看| 亚洲日韩视频| 欧美国产精品日韩| 亚洲三级网站| 亚洲色图在线视频| 欧美午夜女人视频在线| 亚洲小说区图片区| 欧美在线91| 极品尤物久久久av免费看| 久久精品视频在线免费观看| 欧美成人tv| 99国产精品| 国产精品国产自产拍高清av| 亚洲欧美国产高清va在线播| 久久久欧美精品sm网站| 激情综合自拍| 欧美交受高潮1| 亚洲少妇诱惑| 久久久久国产精品午夜一区| 在线成人激情| 欧美日韩大片| 亚洲欧美日韩精品综合在线观看| 欧美在线观看天堂一区二区三区| 国产性做久久久久久| 久久久久一区二区三区| 国产欧美精品在线| 久久精品国产视频| 久久精品国产久精国产思思| 欧美一区激情视频在线观看| 老司机一区二区三区| 亚洲精品日本| 国产精品亚洲欧美| 久久亚洲影院| 99热免费精品在线观看| 久久精品国产99| 亚洲国产小视频| 国产精品国产三级国产aⅴ9色| 欧美一区二区国产| 亚洲人体偷拍| 久久久久久穴| 亚洲免费观看高清完整版在线观看熊| 欧美日韩国产页| 欧美在线一二三四区| 亚洲国产精品久久久久| 久久精品国产999大香线蕉| 亚洲精品国产精品乱码不99按摩| 国产精品免费福利| 男女精品网站| 欧美一区二区三区在线| 亚洲精品综合精品自拍| 久热re这里精品视频在线6| 亚洲一区二区3| 亚洲人成欧美中文字幕| 国内精品久久久久影院色| 欧美日韩国产区一| 免费日韩一区二区| 久久国产精品一区二区三区| 亚洲永久免费视频| 亚洲欧洲精品成人久久奇米网| 久久青草久久| 欧美在线亚洲在线| 亚洲一区二区黄色| 亚洲卡通欧美制服中文| 亚洲国产免费看| 一区二区视频欧美| 国产在线高清精品| 国产农村妇女毛片精品久久麻豆| 欧美日韩国产色视频| 欧美激情一二三区| 欧美国产日韩视频| 免费不卡在线观看av| 久久婷婷国产麻豆91天堂| 欧美一区二区三区在线| 性欧美xxxx大乳国产app| 亚洲欧美日韩在线| 亚洲在线视频| 亚洲欧美影院| 欧美在线啊v一区| 欧美在线免费播放| 久久精品99| 久久免费午夜影院| 免费成人黄色片| 欧美 日韩 国产 一区| 免费成人黄色| 欧美激情一区二区三级高清视频| 欧美韩国一区| 欧美日韩亚洲综合| 国产精品国产| 国产一区二区三区四区三区四| 国产亚洲欧洲997久久综合| 好吊成人免视频| **性色生活片久久毛片| 最新国产成人在线观看| 一本色道久久综合亚洲精品小说| 一本色道久久综合亚洲精品不卡| 亚洲性感美女99在线| 欧美一乱一性一交一视频| 香蕉成人久久| 可以免费看不卡的av网站| 亚洲成在线观看| 一本综合久久| 久久国产视频网| 欧美91精品| 国产精品久久久久久久久免费桃花| 国产精品最新自拍| 亚洲二区视频在线| 亚洲特黄一级片| 久久久蜜桃精品| 亚洲三级免费观看| 性色av一区二区三区| 欧美.www| 国产人成精品一区二区三| 亚洲二区在线观看| 香蕉乱码成人久久天堂爱免费| 久久亚洲捆绑美女| 日韩一级免费观看| 久久精品国产第一区二区三区最新章节 | 校园激情久久| 欧美黄色aaaa| 国产欧美激情| 亚洲美女在线看| 欧美在线播放一区| 亚洲精品美女91| 欧美在线免费看| 欧美无砖砖区免费| 亚洲激情亚洲| 久久国产精品一区二区| 亚洲精品系列| 老色鬼久久亚洲一区二区| 国产精品一区在线观看| 亚洲久久一区| 免费观看不卡av| 午夜精品视频| 国产精品福利影院| 日韩午夜一区| 亚洲国产精品嫩草影院| 久久久av网站| 国产亚洲精品激情久久| 亚洲一区二区三区在线观看视频 | 亚洲天堂av图片|