为Unity项目生成文档(一)

VS生成chm帮助文档

VS代码中使用Xml注释，并通过Sandcastle生成chm文档的文章,这几篇值得分享：

• 使用.NET中的XML注释(一) -- XML注释标签讲解
• 使用.NET中的XML注释(二) -- 创建帮助文档入门篇

VS的XML注释语法：

微软的建议

建议的文档注释标记（C# 编程指南）

标记

注释示例

请重点看下面方法的xml注释：

/// <summary>

        ///     根据用户Id得到用户名.

///         此处添加第二段Summary信息,在MSDN中很少使用.所以不推荐使用.

/// </summary>

///     如果没有找到用户则返回null.<br/>

///     用户Id模型属性定义参见<see cref="UserInfo.UserId"/><br/>

/// </remarks>

/// <returns>用户真实姓名</returns>

///     返回用户id为100的用户真实姓名:

///         private string userName = string.Empty;

///     </code>

///     <c>if(userName!=null){...}</c>

/// <exception cref="System.ApplicationException">

/// </exception>

        {

            string result = string.Empty;

            {

                throw new System.ApplicationException();

            }

                result = null;

"Robert";

        }

生成chm文档后的截图

文档摘要

文档详细信息

（编辑：北几岛）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!