为Unity项目生成文档(一)

本文为作者原创,转载请注明出处:https://www.cnblogs.com/zhaoqingqing/p/3954169.html



VS生成chm帮助文档#

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

VS的XML注释语法:#

微软的建议#

建议的文档注释标记(C# 编程指南)

标记#

image

注释示例#

请重点看下面方法的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文档后的截图

image

文档摘要#

image

文档详细信息#

image

作者:赵青青   一名在【网易游戏】做游戏开发的程序员,擅长Unity3D,游戏开发,.NET等领域。
本文版权归作者和博客园共有,欢迎转载,转载之后请务必在文章明显位置标出原文链接和作者,谢谢。
如果本文对您有帮助,请点击【推荐】您的赞赏将鼓励我继续创作!想跟我一起进步么?那就【关注】我吧。
posted @   赵青青  阅读(2355)  评论(0编辑  收藏  举报
编辑推荐:
· .NET Core 托管堆内存泄露/CPU异常的常见思路
· PostgreSQL 和 SQL Server 在统计信息维护中的关键差异
· C++代码改造为UTF-8编码问题的总结
· DeepSeek 解答了困扰我五年的技术问题
· 为什么说在企业级应用开发中,后端往往是效率杀手?
阅读排行:
· 10亿数据,如何做迁移?
· 推荐几款开源且免费的 .NET MAUI 组件库
· 清华大学推出第四讲使用 DeepSeek + DeepResearch 让科研像聊天一样简单!
· 易语言 —— 开山篇
· Trae初体验
历史上的今天:
2013-09-03 Mecanim分析
2013-09-03 Mecanim 动作复用示例
CONTENTS
点击右上角即可分享
微信分享提示