R_代码编写规范
以下为《R_代码编写规范》的无排版文字预览，完整内容请下载
代码编写规范
代码编写规范
适用于C#、Java、托管C++，等具有运行时环境的语言。其他特定语言规范请自觉遵守相关的基本原则。
命名规范
包、命名空间、类名
类名、模块、命名空间、包名称所有单词第一个字母大写，其他字母小写。(即所谓的Pascal命名规则)。其中类名、模块名称、命名空间、包名称都应该是名词或名词词组。方法名称是动词或动词词组。
例如 ： public class PersonInfo 、package PersonOperationModule、
方法
C#：C#方法名称命名与上面1.1.2中的命名规范一致 ，
例如：public void UpdatePersonInfo(PersonInfo pi)
Java：按照传统规范方法名第一个字母小写
例如：public void updatePersonInfo(PersonInfo pi)
常量
常量名称使用上面提到的Pascal命名或是全部大写形式，如果使用全部大写规则，那么单词之间应该以下划线分割。
例如：MaxArrayLength、MAX_ARRAY_LENGTH
局部变量、方法参数
局部变量、方法参数的命名采用混合大小写形式，即除了第一个单词，所有单词的第一个字母要大写，其他字母小写（即所谓的Camel命名规则）。同时局部变量和方法参数应该是名词或名词词组。
例如：totalCount，pageSize，pageCount
循环内部变量
for、while 等循环的内部变量应尽量从简，使用一个小写字母表示。
例如：
for ( int i = 0; i < count; i++ )
{
…
}
缩进及间隔
缩进用TAB不用 SPACES。注释需和代码对齐。同时提倡开发人员使用相应的开发工具中的格式化快捷键(VisualStudio 为选中代码Ctrl+K Ctrl+F )。快速高效的格式化代码。
C#：花括弧 ( {} ) 需要和括号外的代码对齐。用一个空行来分开代码的逻辑分组。
例如：
public bool SayHello (string name)
{
…
}
Java：可以按照通常的习惯花括号与方法名称同行
public bool SayHello (string name){
…
}
文件及代码量
不要使用大文件
无论是前台aspx、jsp、html页面还是后台的.java 、.cs、.vb的源代码文件。所放置的代码量不宜过大。保持在300 – 400行以下为宜。前台页面的复用代码应抽取到UserControl(.Net)或是局部模板中(java)中。后台源代码文件的通用代码应抽取到独立的类库文件中。
类、方法的代码不宜过长
类中的方法不宜过多而造成”大类”、”臃肿类”。这种代码是后期维护的噩梦。
方法中的代码不能超过40行。重复和或是通用的处理逻辑应该抽取出来形成独立的方法。
常量及硬编码处理
不允许在代码中使用硬编码的字符串字面量
应该将所有字符串字面量统一存放在项目中的常量定义文件中。并定义为public static readonly string以得到更好的性能。
必要时使用enum，别用数字或字符串来指示离散值。
有必要时页面中的字符串应放入资源文件便于统一处理及多语处理
不在代码中使用具体的路径和驱动器名，使用相对路径，并使路径可编程。永远别设想你的代码是在“C:”盘运行。你不会知道，一些用户在网络或“Z:”盘运行程序。应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。
代码复用
类、接口、方法的设计应该符合单一指责原 内容过长，仅展示头部和尾部部分文字预览，全文请查看图片预览。 SQL语句基本准则
禁止使用拼接SQL语句的方式，应以参数的方式进行传递
避免使用SELECT * 语句；
WHERE子句尽量避免使用函数；
避免在ORDER BY子句中使用表达式；
限制在GROUP BY子句中使用表达式；
尽量不用子查询
视图嵌套使用不能超过3层；
避免隐式类型转换，例如字符型一定要用’’，数字型一定不要使用’’；
慎用DISTINCT关键字；
慎用UNION关键字，可以用OR替代；
使用top 1替count(*)来判断是否存在记录；
SQL语句使用建议
大小写规范统一，变量绑定统一，避免重复编译；
尽可能少的返回结果集行的数量
减少结果集中的列的数量；
慎用游标；
[文章尾部最后300字内容到此结束,中间部分内容请查看底下的图片预览]
以上为《R_代码编写规范》的无排版文字预览，完整内容请下载
R_代码编写规范由用户“漫过巴黎275”分享发布，转载请注明出处