C#代码注释规范及文档生成
来源:互联网 发布:淘宝网购物男装外套 编辑:程序博客网 时间:2024/05/01 08:05
原文:C#代码注释规范及文档生成
开发注释是 // 帮助拓展代码
开发注释:辅助开发,对变量或者函数等代码的后续开发做的注释。
使用注释是 /// 帮助使用代码
使用注释:帮助使用,主要是对使用变量或函数等代码的使用调用做的注释。
开发注释:辅助开发,对变量或者函数等代码的后续开发做的注释。
例如,你定义了一个私有变量 private int coins; 不打算让外部访问该变量。但在开发过程中,需要一些提示。
//金币的数量private int coins;
使用注释是 /// 帮助使用代码
使用注释:帮助使用,主要是对使用变量或函数等代码的使用调用做的注释。
例如上面的coins变量,我们打算让外部能访问。那么代码是public int coins; 在这段代码前输入///
则Mono会自动根据变量名生成如下注释,summary是对下方代码的总结。
2.能根据该格式的注释自动生成文档
文档生成器
/// <summary>/// The coins. /// </summary> public int coins;之后你可以自己添加注释如
/// <summary>/// 金币总数 /// </summary> public int coins;或者按行输入文本, <para></para> 代表一行
/// <summary>/// <para>金币数</para>/// <para>可以当钱花</para>/// </summary> public int coins;
函数也是同样的写法。
有函数如下
public void UseCoins(intnumber) { }在函数前输入/// , 得到如下,其中 <param name='number'> </param>代表一个参数
/// <summary>/// Uses the coins. /// </summary> /// <param name='number'>/// Number. /// </param> public void UseCoins(intnumber){ }
这么写的好处是:
1.调用时弹出注释,如下
2.能根据该格式的注释自动生成文档
文档生成器
0 0
- C#代码注释规范及文档生成
- Unity3D C#代码注释规范及文档生成
- 【风宇冲】Unity3D教程宝典之 C#代码注释规范及文档生成
- 【风宇冲】Unity3D教程宝典之 C#代码注释规范及文档生成
- C#代码注释规范 .NET生成API文档
- C#文档注释规范
- C#文档注释规范
- C#文档注释规范
- C# 文档注释规范
- C# 文档注释规范
- C# 代码注释规范
- C# 代码注释规范
- Doxygen C++注释规范及生成帮助文档配置步骤
- C#文档注释规范示例
- C#代码生成XML文档以及规范XSD
- Javascript代码及注释规范
- doxygen的文档生成,注释规范
- Ecplise 文档注释及生成
- Android Listview中使用两种布局
- AWS 经典的3层web app部署架构图
- ASP.NET的Session 详解
- Git 常用命令整理
- c++ ANSI、UNICODE、UTF8互转
- C#代码注释规范及文档生成
- fedora 下搭建DNS服务器
- C++中Ansi、Unicode、UTF8字符串之间的转换和写入文本文件
- python(py2exe)打包成exe执行文件,vista/win7下icon图标显示问题的解决方案
- 真爱来临时,你要怎么留得住
- 仿win8磁贴界面以及功能
- 小强的HTML5移动开发之路(39)——jqMobi插件json格式ActionSheet
- 肥僮谈朔
- 网站美工-配色方案