规则归类
- 【强制】
- 【推荐】
文案
- 【强制】中文文案排版,请参考《中文文案排版指北》进行中文排版。
- 【强制】提示给用户的说明文字结尾一般不需要标点符号。如果有断句,则可以以句号结尾。不应该使用感叹号结尾。
CSS
- 【强制】CSS 书写顺序:
- 位置属性(position,top,right,z-index,display,float 等)
- 大小(width,height,padding,margin)
- 文字系列(font,line-height,letter-spacing,color,text-align 等)
- 背景(background,border 等)
- 其他(animation,transition 等)
CSharp
【强制】类的私有属性使用下划线开始的 lowerCamelCase 命名。示例:
/// <summary> /// 订单标识 /// </summary> private string _orderId;
- 【强制】方法内部变量使用 lowerCamelCase 命名。
- 【推荐】命名空间最多保留一级在代码行中,其余的应该通过 using 的方式引入。
【推荐】能给阅读带来很大的帮助时才使用命名参数【命名参数】。
命名参数(Named Arguments)就是说在调用函数时可以通过指定参数名称的方式来调用参数。它最大的好处就是方便调用参数时按调用者的需要来排列顺序,而不必死守函数声明时的顺序,同时结合默认参数值的特性,可以选择使用默认参数还是不使用默认参数。坏处:不能修改被调用函数的参数名称,否则编译会出错。
SQL
- 【强制】SQL 语句中别名必须加 AS 关键字,以保证数据库兼容性。
- 【强制】SQL 语句关键字大写。
- 【推荐】SQL 语句中尽量不要做时间之类的格式化,以保证查询性能。
- 【强制】SQL 语句的执行必须要参数化,以防止 SQL 注入。
- 【强制】使用 -- 进行行注释时,-- 后必须保留有且只有一个半角空格。
markdown
【强制】.markdownlint.yaml
MD002: false # First heading should be a top level heading MD013: false # Line length MD024: { siblings_only: true } # Multiple headings with the same content MD040: false # Fenced code blocks should have a language specified MD041: false # First line in file should be a top level heading