大家好,欢迎来到IT知识分享网。
相信很多码农刚进入一家公司时,自己的导师都会第一时间让自己看看公司的代码规范,代码规范的统一就像我们军训时要求做的动作一样–整齐划一,相信同行都会感受到不规范的代码带给大家的痛苦是怎样的(这里省略一万字你们懂得…..)
我这里只是列举了适合#金蝶云星空#插件开发的要求
通用模块
- 销售模块:SAL
- 采购模块:PUR
- 基础资料:BD
- 财务模块:FIN
- 计划模块:PLN
- 生产订单:PRD
- 委外订单:SUB
BOS
- 新建的单据标识:公司简称_模板名_单据含义
- 新创建的表单头:公司简称_模块名_表含义
- 新创建的表单身:公司简称_模块名_表含义Entry
- 扩展的字段:F公司简称+字段含义
数据库
- 视图:V_公司简称_模块名_视图含义
- 存储过程:P_公司简称_模块名_存储过程含义
代码
- 标识符采用匈牙利命名法:在命名中加入表示类型的前缀,前缀小写。如:strName。
- 类型统一如下:
- string:strName
- int:iAge
- Doulbe:dAmount;
- Datetime:dtmStart
- Bool:bResult
- Datatable:dtOrder
- Dataset:dsOrder
- List:lstOrders
- Array:arryNames;
- 类公共变量加_前缀:_Result
- Array,list,数组的变量名后加s表示复数
- 标识符的命名要清晰、明了,有明确含义,同时使用完整的英文单词,避免使人产生误解。若是使用特殊约定或缩写,则要有注释说明。切忌使用拼音来命名。
- 类和方法,用 pascal大写规则来命名:第一个字母大写,每个单词的首字母也大写。比如ShipNoteList和PrintInvoice()
- 标识符只能由26个字母,下划线,10个数字组成。禁止使用连续的下划线。下划线也不能出现在标识符的最前面或者最后面。
- 对于变量命名,禁止取单个字符(如i、j、k),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。
- 常量必须使用大写字母,用下划线分割字母。
- 程序块的分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
- 类、方法、属性的属性采用XML文档格式注释。文件头部,代码间多行注释,为/*… */,单行注释为//…
- 函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值。
- 避免在注释中使用缩写,特别是非常用缩写。
- 数据库操作、IO操作等需要使用结束close()的对象必须在try -catch-finally 的finally中close()。
- 不允许把多个短语句写在一行中,即一行只写一条语句。
WebAPI
- 所有WebAPI涉及到数据库操作的操作语句都得使用参数化形式,防止SQL注入式攻击
如有不对的地方还请各位大神指出,谢谢!
免责声明:本站所有文章内容,图片,视频等均是来源于用户投稿和互联网及文摘转载整编而成,不代表本站观点,不承担相关法律责任。其著作权各归其原作者或其出版社所有。如发现本站有涉嫌抄袭侵权/违法违规的内容,侵犯到您的权益,请在线联系站长,一经查实,本站将立刻删除。 本文来自网络,若有侵权,请联系删除,如若转载,请注明出处:https://yundeesoft.com/6775.html