C#开发:从命名规范到工具使用
1. XML文档标签参考
在编写代码时,良好的文档注释能极大提升代码的可读性和可维护性。以下是一些常用的预定义XML标签及其描述:
| 标签 | 描述 |
| — | — |
| <summary>
| 描述一个类型或成员,通常是对成员的高层次描述。示例: <summary>这是一个方法的描述</summary>
|
| <remarks>
| 为特定成员提供额外信息,如方法的副作用或非直观的行为。例如: <remarks>此方法在参数大于5时可能抛出ArrayOutOfBoundsException</remarks>
|
| <param>
| 描述方法的参数, name
属性必须指定且引用方法的参数。示例: <param name="param1">参数1的描述</param>
|
| <returns>
| 描述方法的返回值。如: <returns>返回一个整数</returns>
|
| <exception>
| 描述方法可能抛出的异常,可选的 cref
属性应引用异常类型。例如: <exception cre