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

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一区二区老牛| 欧美在线日韩| 久久国产日韩| 亚洲精品中文字幕在线| 亚洲精品一二三| 国产精品久久久久久久app| 亚洲线精品一区二区三区八戒| 亚洲一区精品在线| 国产真实乱子伦精品视频| 欧美插天视频在线播放| 欧美欧美全黄| 欧美一区二区三区在线观看视频| 久久精品欧美| 一本久道久久综合婷婷鲸鱼| 亚洲婷婷综合久久一本伊一区| 国产在线精品二区| 亚洲黄一区二区| 国产精品色婷婷久久58| 欧美1级日本1级| 欧美性猛交xxxx乱大交退制版 | 久久成人人人人精品欧| 久久精品国产69国产精品亚洲| 亚洲国产精品专区久久| 亚洲一区二区三区国产| 91久久精品一区| 亚洲一区免费| 一本到高清视频免费精品| 久久福利资源站| 亚洲少妇自拍| 久久综合综合久久综合| 亚洲欧美一区二区原创| 欧美精品观看| 蜜臀久久久99精品久久久久久| 欧美午夜精品久久久久久久| 欧美激情第二页| 国产一区二区三区视频在线观看| 99re在线精品| 亚洲国产欧美日韩精品| 久久久99免费视频| 欧美一级艳片视频免费观看| 欧美色综合网| 亚洲精选久久| 99国产精品私拍| 另类成人小视频在线| 久久精品一区二区三区不卡牛牛| 欧美视频精品在线| 日韩网站在线观看| 亚洲免费观看高清完整版在线观看熊| 久久www成人_看片免费不卡| 午夜在线视频观看日韩17c| 欧美片第一页| 亚洲人精品午夜| 日韩视频在线观看| 欧美大片国产精品| 亚洲大片av| 亚洲人成亚洲人成在线观看图片 | 亚洲精品在线观看免费| 亚洲精品美女久久久久| 欧美 日韩 国产 一区| 亚洲福利视频一区二区| 亚洲国产成人在线| 理论片一区二区在线| 亚洲高清久久网| 亚洲精品久久久久久下一站| 欧美成人精品在线视频| 亚洲国产三级网| 99国产精品久久久久久久成人热 | 久久久夜精品| 亚洲国产mv| 一区二区三区精品视频在线观看 | 久久久噜噜噜| 欧美成人午夜激情| 亚洲美女黄网| 国产精品久久国产三级国电话系列| 99天天综合性| 欧美一区二区视频观看视频| 狠狠噜噜久久| 欧美不卡高清| 中文欧美日韩| 久久久人成影片一区二区三区| 在线观看视频一区二区| 欧美插天视频在线播放| 9久re热视频在线精品| 久久激情五月婷婷| 亚洲高清自拍| 欧美日韩免费高清一区色橹橹| 亚洲宅男天堂在线观看无病毒| 久久精品国产亚洲一区二区| 亚洲欧洲精品天堂一级| 欧美系列精品| 麻豆精品在线播放| 99re8这里有精品热视频免费 | 亚洲精品偷拍| 久久精品国产成人| 99热这里只有成人精品国产| 国产精品综合| 欧美国产日韩免费| 午夜精品久久久久久久久| 亚洲国产精品久久久久秋霞影院| 亚洲一二三区精品| 亚洲第一精品福利| 国产精品美女www爽爽爽| 模特精品在线| 亚洲欧美日韩精品在线| 亚洲国产99| 久久久综合网| 亚洲自拍偷拍福利| 亚洲国产婷婷综合在线精品| 国产日本亚洲高清| 欧美午夜精品久久久久久人妖 | 午夜精品久久久久久久蜜桃app| 亚洲成色999久久网站| 欧美中文在线观看| 亚洲视屏在线播放| 亚洲区第一页| 一区二区视频欧美| 国产亚洲欧美日韩日本| 欧美日韩在线视频一区| 美女精品在线| 久久婷婷一区| 久久久久一区二区| 欧美在线一二三四区| 亚洲视频一区二区免费在线观看| 亚洲黄色尤物视频| 免费永久网站黄欧美| 久久国产精品免费一区| 欧美一区二区在线观看| 亚洲你懂的在线视频| 亚洲天堂av在线免费| 亚洲另类一区二区| 99综合在线| 日韩系列欧美系列| 亚洲伦理在线免费看| 91久久久一线二线三线品牌| 亚洲国内高清视频| 亚洲日本国产| 亚洲欧洲在线免费| 99国内精品久久| 夜夜嗨av一区二区三区中文字幕 | 亚洲小说欧美另类婷婷| 亚洲天堂男人| 亚洲欧美日韩国产| 亚洲欧美日韩国产精品 | 亚洲精品国产精品久久清纯直播 | 亚洲视频欧美视频| 亚洲影院色无极综合| 亚洲欧美日韩专区| 欧美在线综合| 欧美 日韩 国产 一区| 欧美成人午夜影院| 欧美精品一区二区三区在线播放 | 国产色综合网| 亚洲二区在线| 亚洲最黄网站| 午夜精品免费| 鲁大师成人一区二区三区| 欧美国产丝袜视频| 亚洲免费观看| 欧美在线观看网址综合| 老妇喷水一区二区三区| 欧美日韩中文字幕| 国产一区二区三区久久久久久久久| 亚洲第一精品夜夜躁人人爽 | 亚洲人精品午夜| 亚洲午夜激情网页| 久久久久久久网| 欧美黄色成人网| 中文在线不卡| 久久久视频精品| 欧美日韩国产综合视频在线观看| 国产精品亚洲第一区在线暖暖韩国| 国产综合色在线视频区| 日韩视频精品在线| 久久久999成人| 日韩亚洲在线| 久久人人爽人人爽爽久久| 欧美性猛交xxxx免费看久久久 | 国产精品v欧美精品v日韩精品 | 欧美精品在线观看一区二区| 国产美女扒开尿口久久久| 亚洲国产精品一区二区第四页av | 欧美高清在线播放| 亚洲影视在线| 欧美黄色片免费观看| 国产欧美日韩另类一区| 99精品视频免费观看视频| 久久久欧美精品sm网站| 日韩一区二区久久| 男人的天堂亚洲| 国内成人精品2018免费看| 亚洲一区二区三区四区中文| 亚洲第一在线视频| 欧美在线影院| 国产一区二区三区直播精品电影| 亚洲视频福利| 亚洲欧洲午夜|