C#编程规范

C#编程规范

文档组织

统一文件名格式

一个文件中只写一个类

统一文件头

• // --------------------------------------------------------------------------------------------
  //
  // Copyright © $CREATE{D}_{Y}EAR$ 科技
  // 版权所有。
  //
  //
  // 文件功能描述：
  //
  // 创建标识：$USE{R}_{N}AME$$CREATE{D}_{Y}EAR$$CREATE{D}_{M}ONTH$$CREATE{D}_{D}AY$
  //
  // 修改标识：
  // 修改描述：
  //
  // 修改标识：
  // 修改描述：
  //
  // ---------------------------------------------------------------------------------------------

命名规范

小驼峰命名法

• 类中私有变量
• 函数参数
• 方法内的变量

大驼峰命名法

• 命名空间、项目名称、解决方案名称
• 类、结构体、枚举变量、接口
• 属性、方法、事件、静态字段

有意义的命名

• 避免难懂的名称，不具体

• 变量具有描述性

• 布尔变量包含is、can、try

• 控件名简写

  • 控件名 简写 控件名 简写
    Label lbl TextBox txt
    Button btn LinkButton lnkbtn
    ImageButton imgbtn DropDownList ddl
    ListBox lst DataGridView dgv
    DataList dl CheckBox chk
    Repeater rpt ComboBox cbo
    CheckBoxList chkls RadioButton rdo
    RadioButtonList rdolt Image img
    Panel pnl Calender cld
    AdRotator ar Table tbl

代码外观

基本约定

• 不使用tap。使用四个空格
• 调用时，显式使用this、base
• 使用string.Empty代替“”，表示空字符串

局部变量声明

• 不在一行写多个声明语句
• 使用内嵌类型

语句块-大括号

• if (condition)
  {
  }

• 左右花括号对齐

• 大括号内语句必须另起新行，并且缩进

• while if 内语句只有一行也要使用{ }

语句块-空格

• while （true） 关键字与左括号之间有空格

• 除了" . " 之外的所有二元操作符都有空格

• 分号；之后有空格 for(1; 2; 3)

• operator关键字后面有空格

• 不需要空格

  • ++ ！ 正负号
  • 括号内头尾不能有空格
  • 匿名数组，new之后不带， new[] {1, 2, 3);

成员规则

属性按照先get 再set规则

注释

单行注释

• 单行注释不能采取三个斜线注释方式
• 单行注释不能跟空白行
• 单行注释一个空格开头

文档注释

• 类、构造函数、方法、属性必须给予文档注释。
• 方法的文档注释中，必须包含所有的参数和返回值
• 文档注释的每一行以一个空格开头
• 文档注释中不能出现空白行

XMind - Trial Version