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

本文详细介绍了C#文档注释的格式及如何生成代码提示和帮助文档,包括选择XML文档文件作为输出、使用sandcastle工具进行HTML或CHM格式的帮助文档生成等关键步骤。

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/

转载于:https://www.cnblogs.com/bluestorm/p/3503855.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值