VS生成chm帮助文档
VS代码中使用Xml注释,并通过Sandcastle生成chm文档的文章,这几篇值得分享:
VS的XML注释语法:
微软的建议
标记
注释示例
请重点看下面方法的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文档后的截图
文档摘要
文档详细信息
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 [email protected] 举报,一经查实,本站将立刻删除。