命名规范 - passiony/gillar_wiki GitHub Wiki

命名规则遵守Microsoft的C＃命名准则，请仔细阅读

https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/naming-guidelines

• 类，方法，枚举，公共字段，公共属性，名称空间的名称：PascalCase。
• 局部变量名称，参数：camelCase。
• 私有，受保护，内部和受保护内部字段和属性的名称：_camelCase。
• 命名约定不受const，static，readonly等修饰符的影响。
• 对于大小写，“单词”是指没有内部空格（包括首字母缩写）的任何内容。例如，MyRpc代替~~MyRPC~~。
• 接口名称开头I，例如IInterface。

​ a）背景（UIImage）：xxxBg

​ b）按钮（UIButton）：xxxBtn

​ c）文本（UIText）：xxxText

​ d）图片（UIImage）：xxxImg

​ e）输入框（UIInput）：xxxInput

​ f）可选中按钮（UIToggel）：xxxToggle

​ j）滑动条组件（UISlider）：xxxSlider

​ k）...

IDE统一使用IntelliJ Idea

• 1.[批注]所有能加批注的，都加上批注（类必须添加批注，常用属性和函数必须添加批注） 。
• 2.[批注]批注注释，写清楚每个参数param和返回值的类型和解释。
• 3.[代码格式化]代码及时格式化，比如每次保存时都进行一次格式化，提升代码的阅读体验。
• 4.[代码格式化]函数和函数之间间隔一行空格。
• 5.函数和类的命名拼写不要拼错，尽量查下翻译。
• 6.常量的声明，统一保持在类文件的声明区域，命名全大写,下划线分割。
• 7.路径，类引用等，统一保持在类文件声明区域，命名大驼峰。
• 8.常用的枚举类型一定要声明枚举，禁止1，2，3，4这样的明文使用。