C# 代码注释生成代码提示和帮助文档


C#文档注释格式:

/// <summary>
/// function description
/// </summary>
/// <param name="para1"></param>
/// <param name="para2"></param>

/// ...
/// <returns>return value</returns>

 

1. C# 生成代码提示(hint)
项目属性 - 生成 的‘输出’选项中,选择xml文档文件。
拷贝类库的时候,要连xml帮助文件一起拷贝。

 

2. C# 生成帮助文档(html/chm..)

使用工具sandcastle:
http://sandcastle.codeplex.com/


免责声明!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系本站邮箱yoyou2525@163.com删除。



 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM