下面（）是C#中文档注释生成？A//注释B/*注释*/C///注释D/**注释*/

下面（）是C#中文档注释生成？A//注释B/注释/C///注释D/**注释*/

点击联系发帖人 时间：2012-12-25 10:56

文档注释生成

3382人阅读
Doxygen是什么
是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语
言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，生成HTML格式的在线类
浏览器，或离线的LATEX、RTF参考手册。对于未归档的源文件，也可以通过配置Doxygen来提取代码结构。或者借助自动生成的包含依赖图
（include dependency graphs）、继承图（inheritance diagram）以及协作图（collaboration
diagram）来可视化文档之间的关系。Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML和Unix
man page等，
而且也支持数学公式的生成。
&& Doxygen在Linux上开发，但也可以在其它的Unix平台下运行。而且，Windows 9x/NT平台下也有对应的可执行版本。
&&& Doxygen中利用到很多第三方的基于编译的信息生成工具，辅助生成更为炫目的文档。比如，你可以在注释中嵌入符合tex标准的公式，Doxygen帮助你把这些显示到你的文档中来；你还可以为你的文档自动生成继承图，组合图，UML格式的图，等品种齐全的图，只要你把
上，并打开相关参数即可。更漂亮的是，利用Graphviz的dot方法，你可以将符合其格式的画图指令写在注释中，场景图，架构图，流图，交互图，隔壁
校长含泪跳楼图，只要你能用Graphviz画出，Doxygen都能给你用上，图例想改就改想变就变，幸福生活，不过尔尔。而关于Graphviz，
了，再多的好话也就显得苍白。这东西无疑是好东西，方便的一塌糊涂，对于常年和代码打交道对直观之物缺失判断的程序员而言，这无疑是居家旅行杀人必备的水
doxygen常用注释命令
doxygen通过注释命令识别注释中需要特殊处理的注释，比如函数的参数、返回值进行突出显示。上面也提到了一些注释命令（如：brief、param、return、以及group相关的命令），下面对其他一些常用的注释命令进行解释说明。
@exception &exception-object& {exception description}
对一个异常对象进行注释。
@warning {warning message } 一些需要注意的事情
@todo { things to be done }
对将要做的事情进行注释
@see {comment with reference to other items } 一段包含其他部分引用的注释，中间包含对其他代码项的名称，自动产生对其的引用链接。
@relates &name& 通常用做把非成员函数的注释文档包含在类的说明文档中。
@since {text} 通常用来说明从什么版本、时间写此部分代码。
@deprecated
@pre { description of the precondition } 用来说明代码项的前提条件。
@post { description of the postcondition } 用来说明代码项之后的使用条件。
@code 在注释中开始说明一段代码，直到@endcode命令。
@endcode 注释中代码段的结束。
注释的书写
注释应该怎么写，写多还是写少。过多的注释甚至会干扰对代码的阅读。写注释的一个总的原则就是注释应该尽量用来表明作者的
意图，至少也应该是对一部分代码的总结，而不应该是对代码的重复或者解释。对代码的重复或者解释的代码，看代码可能更容易理解。反映作者意图的注释解释代
码的目的，从解决问题的层次上进行注释，而代码总结性注释则是从问题的解答的层次上进行注释。
推荐的写注释的过程是首先使用注释勾勒出代码的主要框架，然后根据注释撰写相应的代码。对各种主要的数据结构、输出的函数、多个函数公用的变量进行详细地注释。对代码中控制结构，单一目的的语句集进行注释。下面是一些写注释时需要注意的要点：
避免对单独语句进行注释；
通过注释解释为什么这么做、或者要做什么，使代码的读者可以只阅读注释理解代码；
对读者可能会有疑问的地方进行注释；
对数据定义进行注释，而不是对其使用过程进行注释；
对于难于理解的代码，进行改写，而不要试图通过注释加以说明；
对关键的控制结构进行注释；
对数据和函数的边界、使用前提等进行注释；
如果只是和我一样的弱智用户的话，改动以下几个地方：
PROJECT_NAME：写下你想要的名字
OUTPUT_DIRECTORY：输出的文件夹，我用的是 ~/Desktop/Floorplan
CREATE_SUBDIRS：改为 YES
EXTRACT_ALL：改为 YES
SHOW_DIRECTORIES：改为 YES
FILE_PATTERNS：一般情况下不用改了，*.c *.h *.cpp *.hpp这些都会自动包含进去
RECURSIVE：改为 YES，你肯定希望包含那些子文件夹里的源码
SOURCE_BROWSER：YES
PDF_HYPERLINKS：YES
USE_PDFLATEX：YES&&&
&doxygen使用步骤
由于只是工具的使用，这里不介绍它的原理，直接从使用步骤开始。Doxygen的使用步骤非常简单。主要可以分为：
1）第一次使用需要安装doxygen的程序
2）生成doxygen配置文件
3）编码时，按照某种格式编写注释
4）生成对应文档
doxygen的安装非常简单， linux下可以直接下载安装包运行即可，下载源代码编译安装也是比较通用的编译安装命令。请参考其安装文档完成安装。
Doxygen在生成文档时可以定义项目属性以及文档生成过程中的很多选项，使用下面命令能够产生一个缺省的配置文件：
doxygen -g [配置文件名]
可以根据项目的具体需求修改配置文件中对应的项，具体的修改过程在下面介绍。修改过的配置文件可以作为以后项目的模板。
让doxygen自动产生文档，平常的注释风格可不行，需要遵循doxygen自己的格式。具体如何写doxygen认识的注释在第3节详细介绍。
OK，代码编完了，注释也按照格式写好了，最后的文档是如何的哪？非常简单，运行下面的命令，相应的文档就会产生在指定的目录中。
doxygen [配置文件名]
需要注意的是doxygen并不处理所有的注释，doxygen重点关注与程序结构有关的注释，比如：文件、类、结构、函数、变量、宏等注释，而忽略函数内变量、代码等的注释。
参考知识库
* 以上用户言论只代表其个人观点，不代表CSDN网站的观点或立场
访问：164327次
积分：2204
积分：2204
排名：第12222名
原创：50篇
转载：33篇
评论：36条
(1)(1)(1)(1)(1)(4)(5)(7)(1)(6)(1)(1)(3)(4)(2)(1)(2)(5)(1)(3)(3)(4)(1)(1)(8)(13)(2)<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
您的访问请求被拒绝 403 Forbidden - ITeye技术社区
您的访问请求被拒绝
亲爱的会员，您的IP地址所在网段被ITeye拒绝服务，这可能是以下两种情况导致：
一、您所在的网段内有网络爬虫大量抓取ITeye网页，为保证其他人流畅的访问ITeye，该网段被ITeye拒绝
二、您通过某个代理服务器访问ITeye网站，该代理服务器被网络爬虫利用，大量抓取ITeye网页
请您点击按钮解除封锁&C++题库_图文_百度文库
两大类热门资源免费畅读
续费一年阅读会员，立省24元！
上传于||文档简介
&&大一C++题库
阅读已结束，如果下载本文需要使用1下载券
想免费下载本文？
定制HR最喜欢的简历
下载文档到电脑，查找使用更方便
还剩396页未读，继续阅读
定制HR最喜欢的简历
你可能喜欢 上传我的文档
 下载
 收藏
该文档贡献者很忙，什么也没留下。
 下载此文档
正在努力加载中...
编程考试基础知识及答案-第一卷
下载积分：900
内容提示：编程考试基础知识及答案-第一卷
文档格式：DOC|
浏览次数：36|
上传日期： 20:45:33|
文档星级：
该用户还上传了这些文档
编程考试基础知识及答案-第一卷
官方公共微信HTML5考试复习资料_百度文库
两大类热门资源免费畅读
续费一年阅读会员，立省24元！
HTML5考试复习资料
上传于||暂无简介
阅读已结束，如果下载本文需要使用0下载券
想免费下载更多文档？
定制HR最喜欢的简历
下载文档到电脑，查找使用更方便
还剩4页未读，继续阅读
定制HR最喜欢的简历
你可能喜欢}

叫阿莫西中心