为Unity项目生成文档(一)
文章目录[点击展开](?)[+]
- VS生成chm帮助文档
- VS的XML注释语法
- 微软的建议
- 标记
- 注释示例
- 文档摘要
- 文档详细信息
VS生成chm帮助文档
VS代码中使用Xml注释，并通过Sandcastle生成chm文档的文章,这几篇值得分享：
- 使用.NET中的XML注释(一) -- XML注释标签讲解
- 使用.NET中的XML注释(二) -- 创建帮助文档入门篇
VS的XML注释语法：
微软的建议
建议的文档注释标记（C# 编程指南）
标记
注释示例
请重点看下面方法的xml注释：
/// <summary>
/// 根据用户Id得到用户名.
/// <para>
/// 此处添加第二段Summary信息,在MSDN中很少使用.所以不推荐使用.
/// </para>
/// </summary>
/// <remarks>
/// 如果没有找到用户则返回null.<br/>
/// <paramref name="userId"/> 参数为正整数.<br/>
/// 用户Id模型属性定义参见<see cref="UserInfo.UserId"/><br/>
/// 相关方法:<seealso cref="UserBL.GetUserId"/>
/// </remarks>
/// <param name="userId">用户Id</param>
/// <returns>用户真实姓名</returns>
/// <example>
/// 返回用户id为100的用户真实姓名:
/// <code>
/// private string userName = string.Empty;
/// userName = UserBL.GetUserName(100);
/// </code>
/// 返回的用户名可能为null,使用时要先判断:<br/>
/// <c>if(userName!=null){...}</c>
/// </example>
/// <exception cref="System.ApplicationException">
/// 如果用户Id小于0则抛出此异常
/// </exception>
public static string GetUserName(long userId)
{
string result = string.Empty;
if (userId < 0)
{
throw new System.ApplicationException();
}
else if (userId == 0)
{
result = null;
}
else
{
result = "Robert";
}
return result;
}
生成chm文档后的截图
文档摘要
文档详细信息
本文转自赵青青博客园博客，原文链接：http://www.cnblogs.com/zhaoqingqing/p/3954169.html，如需转载请自行联系原作者
为Unity项目生成文档(一)相关推荐
- 如何用ant给Java项目生成文档
build.xml源代码: <?xml version="1.0"?> <project name="jerryjsp" basedir=&q ...
- django集成Sphinx，为项目自动生成文档
Sphinx是一个工具,可以轻松创建智能和漂亮的文档,他与Python自带的pydoc是同一类产品,但比pydoc更加优秀,还有很多主题可以选择,平时在开发过程中,我们看到的第三方包的文档,基本上都是 ...
- Objective-C自动生成文档工具:appledoc
作者 iOS_小松哥 关注 2016.12.13 15:47* 字数 919 阅读 727评论 10喜欢 35 由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective-C自动生成文 ...
- Objective-C 自动生成文档工具:appledoc
来源:iOS_小松哥 www.jianshu.com/p/fd4d8d6b6177 如有好文章投稿,请点击 → 这里了解详情 由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective ...
- 快速优雅的为React组件生成文档
在开发React组件时我们通常需要处理2个问题: 实例化这个组件以便调试 为这个组件编写使用文档以便更好的让别人知道怎么使用这个组件 最原始的方法莫过于开发时建一个页面用于调试,开发完后再为其手写文档 ...
- linux c/c++ 代码使用 doxygen 自动生成文档
www.doxygen.org 的使用非常方便,下面分成2步介绍一下 1. 注释风格,需要在c/c++代码中按照下面的风格添加注释,基本上还是很顺手的 C++的注释风格 主要使用下面这种样式:即在注释 ...
- 使用DocFX生成文档
使用DocFX命令行生成文档 使用docfx 命令 1.下载 https://github.com/dotnet/docfx/releases 2.使用 创建初始项目 docfx init -q 此命 ...
- docwizard c++程序文档自动生成工具_如何开发一个基于 TypeScript 的工具库并自动生成文档
为什么用 TypeScript? TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. Any ...
- 配置WCF同时支持WSDL和REST，swaggerwcf生成文档
配置WCF同时支持WSDL和REST,SwaggerWCF生成文档 VS创建一个WCF工程,通过NuGet添加SwaggerWcf 创建完成后通过 程序包管理控制台 pm>Install-Pac ...
最新文章
- ARM Cortex-M嵌入式C基础编程（上）
- UVA 1331 Minimax Triangulation DP， 三角剖分
- c语言编程小项目300行,求几个c语言的小项目做？
- 开源图形化SFTP客户端winscp入门
- 归并排序比较次数_归并排序「从入门到放弃」
- 本地运行flowable_在CockroachDB上运行Flowable
- Django---模版层
- Oracle创建视图的一个问题
- cnn输入层_基于 CNN 的文本分类算法
- 前端计算机英语单词，解决文件命名，变量命名头皮发麻，单词超多1700个前端专属单词，css常用命名单词【起名字太烦了全背下来内卷吧小伙伴大前端时代来临了】
- 接触了阿里云国际版香港服务器，让我学会了飞一般的乐趣
- 你的支付授权失败。请核对你的信息并重试，或尝试其他支付方式。 解决方案
- html内容太大超过盒子范围,HTML内容超过div宽度不能自动换行解决方法
- Android 设置边距总结
- 618家用投影仪推荐！当贝投影F3成大众首选！
- SQL注入-安全狗apache绕过
- 修复损坏的gz或tar.gz压缩文件之方法篇
- linux 查看磁盘信息
- unity基础知识----unity界面菜单翻译
- 女生学大数据好找工作么