文章目录
- 前言
- 一、帕斯卡命名法+驼峰命名法
- 二、变量、方法、注释...
- 1.【变量】不要把多个变量定义到一行,会降低可读性,int x,y,z,...赋值;以及int x = 10, y = 20, ...;这两种写法都不建议
- 2.【方法】扩展方法中,this参数加于形参列表中的第一个形参上、这个方法必须是静态的公有的【也就是被public static修饰的】,方法所在类的名字必须是this所在的第一个形参的数据类型大驼峰+Extension(类命名规范)
- 3..net规定,如果委托是为声明某个事件做准备,那么这个委托命名为XxxEventHandler,Xxx是事件的名字
- 4.当没有明确引入命名空间时【C#中的using...,Java中的import导包时】,需带上System.Xxx.Xxx...去实例化等,这个跟Java中是一样的,你没有import去导包,那么就得带上全包名或者命名空间去加以区别。
- 5.一行一语句、一行一声明、方法定于与属性定义之间添加至少一个空白行
- 6.注释
- 巨人的肩膀
前言
搞编程的,在工作中学习中,培养好的代码习惯、养成自己的一套代码风格,还是比较重要的,与诸君共勉。
一、帕斯卡命名法+驼峰命名法
写代码时或者Code Review时多多参考:帕斯卡命名法/拼写法【https://learn.microsoft.com/zh-cn/dotnet/csharp/fundamentals/coding-style/coding-conventions】
1.命名接口interface时,使用 pascal 大小写并在名称前面加上前缀 I。 这可以清楚地向使用者表明这是 interface。比如IWorkerQueue
2.使用帕斯卡大小写
- 编写位置记录时,对参数使用 pascal 大小写,因为它们是记录的公共属性
- 命名类型的 public 成员(例如字段、属性、事件、方法和本地函数)时,使用 pascal 大小写
- 命名class、record、struct时,使用pascal 大小写(“PascalCasing”)
3.驼峰:
- 命名 private 或 internal 字段时,使用驼峰式大小写(“camelCasing”),以 _ 作为前缀。
- 使用为 private 或 internal 的static 字段时 s_ 前缀
- 对于线程静态,请使用 t_ ;
二、变量、方法、注释…
1.【变量】不要把多个变量定义到一行,会降低可读性,int x,y,z,…赋值;以及int x = 10, y = 20, …;这两种写法都不建议
2.【方法】扩展方法中,this参数加于形参列表中的第一个形参上、这个方法必须是静态的公有的【也就是被public static修饰的】,方法所在类的名字必须是this所在的第一个形参的数据类型大驼峰+Extension(类命名规范)
- 你要扩展某个方法时,也就是某个方法你要给人家第一个形参加上this,让你有超能力原来使用不了人家现在可以使用了,那么这个方法必须是public static修饰的静态的公有的方法,这个方法所在类的名字必须是XxxExtension
3…net规定,如果委托是为声明某个事件做准备,那么这个委托命名为XxxEventHandler,Xxx是事件的名字
- 事件处理委托一般以XxxEventHandler结尾
- 触发事件的经常时一个函数,.NET一般以OnXxx命名
- 事件处理程序的参数应该和事件委托相同,比如都是sender,e。.net规定,如果这个class是用来传递事件信息的,这个类的名字应该是你事件的名字加上EventArgs,并且应该继承EventArgs这个基类
4.当没有明确引入命名空间时【C#中的using…,Java中的import导包时】,需带上System.Xxx.Xxx…去实例化等,这个跟Java中是一样的,你没有import去导包,那么就得带上全包名或者命名空间去加以区别。
5.一行一语句、一行一声明、方法定于与属性定义之间添加至少一个空白行
6.注释
- 注释放在单独的行上而不是代码行的末尾
- 注释文本以大写字母开始
- 句号结束注释文本、注释开始一空格
巨人的肩膀
- https://learn.microsoft.com/zh-cn/dotnet/csharp/fundamentals/coding-style/coding-conventions
- 菜鸟教程
- C#高级编程