我的C#编码规范

发布时间 2023-06-08 21:07:40作者: 左眼水星

命名约定

帕斯卡拼写法(PascalCasing):

  • 命名所有public成员和命名class、record、struct、interface、namespace时。

驼峰式大小写(camelCasing):

  • 命名private或internal字段时。
  • 方法参数。

前缀和后缀:

  • 命名属性类型时, 使用后缀 Attribute
  • 命名interface时, 使用前缀 I
  • 命名private或internal字段时,使用前缀 _  ,如果同时是static使用前缀 s_   ,如果有[ThreadStatic]特性使用前缀 t_
  • 命名异步方法时,使用后缀 Async

注释约定

  • 将注释放在单独的行上,而非代码行的末尾。
  • 以句点结束注释文本。
  • 在注释分隔符 (//) 与注释文本之间插入一个空格。
  • 勿在注释周围创建格式化的星号块。
  • 确保所有公共成员都有必要的 XML 注释,从而提供有关其行为的适当说明