C# 自动生成代码API文档


暂时没学会正规的转载style临时记录一下

NET中的规范标准注释(一) -- XML注释标签讲解

http://www.cnblogs.com/mq0036/p/3544264.html

NET中的规范标准注释(二) -- 创建帮助文档入门篇

http://www.cnblogs.com/mq0036/p/3544268.html

 

简言之:

1. 设置build参数,使XML可以生成在独立于代码的xml文件中。

2. 代码开发过程中养成添加备注的好习惯。VisualStudio中方法或类前输入///会自动生成框架

3. 用工具生成SandCastle生成帮助文档。(感觉工具有点老,不知道是否有新的集成方案在VS2015中)


免责声明!

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



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