C#常见的命名规范抽象类的使用
⼀、命名规范
使⽤有意义的英⽂名称,确保单词拼写正确及语法正确。
缩写时使⽤常规的缩写,禁⽌“创造缩写”。
1.1 命名空间/类/结构体/属性/常量/枚举(包括值)/⽅法(包括事件等)
Pascal(⾸字母⼤写)命名⽅式。
私有字段使⽤“_”开头。
1.2 字段/参数/变量
Camel(⾸字母⼩写)命名⽅式。
1.3 接⼝
I开头进⾏命名。
1.4 抽象类/基类
Base结尾进⾏命名。
1.5 异常类
Exception结尾。
⼆、注释规范
类、结构体、属性、字段这些能够使⽤⽂档注释的的地⽅,使⽤⽂档注释。
关键逻辑使⽤单⾏/多⾏注释,注释段落单⾏超过120个字符(包括本⾏缩进及空格在内,⼀整⾏不得超过120字符)使⽤多⾏注释。
三、代码规范
3.1 this
this不可省略。
3.2 花括号
左右花括号内容为空则左右花括号在同⼀⾏,否则单独⼀⾏。不使⽤忽略的左右花括号。
3.3 三⽬运算符
if else结构代码主体只有单⾏代码时,使⽤三⽬运算符。
3.4 代码超长
单⾏代码最长120字符,超长需要换⾏,换⾏处相对上⼀⾏缩进4个空格,但是不需要多次缩进。
赋值超长时,在“=”处进⾏换⾏,“=”不需要跟随换⾏。
var studentList =
new List<Student>();
链式调⽤超长时,运算符及⽅法调⽤的“.”处进⾏换⾏,“.”需要跟随换⾏,并且后续调⽤全部换⾏。
studentList.Where(p => p.No > 100)
.OrderBy(p => p.No)
.
Select(p => p.No);
参数声明/传递超长时,参数分隔的“,”处进⾏换⾏,“,”不需要跟随换⾏。
public void Init(int no, string name,
int age, string className)
{
this.No = no;
}
myStudent.Init(
1, "张三",
20, "⼀班");
选择条件超长时,在“&&”“||”等条件运算符处换⾏,条件运算符需要跟随换⾏,同⼀级条件对齐。if(myStudent.No == 1
&& myStudent.Age == 30
&& myStudent.ClassName == "⼀班")){}
三⽬运算符超长时,在“?”“:”处进⾏换⾏,“?”“:”不需要跟随换⾏。
myStudent.No == 1 ?
myStudent.Age = 30 :
myStudent.ClassName = "⼀班";

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。