有一句话不理解，什么叫“避免使用方法级的文档，而使用扩展的API文档说明之”，请举个例子。

Question

有一句话不理解，什么叫“避免使用方法级的文档，而使用扩展的API文档说明之”，请举个例子。

Answer 1

/// <summary>
/// 这个就叫方法级文档
/// </summary>
/// <param name="e"></param>
/// 更多说明...
protected override void OnLoad(EventArgs e)
扩展的API文档就是独立存在的开发说明文档...这只是一个建议，因为使用者未必能看到你的代码，独立文档有助于使用者方便的了解接口方法的细节...但是你引用的这句话是断章取义...后面还有半句：在方法需要被其他的开发者使用时使用方法级注释...

Answer 2

事实上方法级文档是非常方便有效的，不应该避免使用...你注意看一下.NET Framework的类库，所有的公共方法都有规范的方法级文档，并且和MSDN这种“扩展的API文档”丝毫不矛盾...毕竟开发者在IDE中查看这些简要的文档比搜索MSDN方便很多...如果有人觉得已经有了详细的API文档就不需要方法级文档，那么他永远达不到微软的高度...

Answer 3

方法级的文档是指//开头的注释；
扩展的API文档说明是指以///敲回车后出现的注释

Answer 4

伙计，你的这种理解是否对呀。与vrhero先生的矛盾呀。