C# 自动生成代码API文档

本文介绍在.NET中如何使用XML注释来规范代码注释,并通过工具自动生成帮助文档。主要内容包括设置生成XML文件的参数、在开发中添加注释的习惯培养以及利用工具生成文档。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

暂时没学会正规的转载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中)

转载于:https://www.cnblogs.com/NikeYingSheng/p/6068384.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值