Delphi编码规范

Delphi编码规范


1、注释
多写注释，要求注释要达到源代码的30%；
在每个单元的最开头以大括号“{注释内容}”的形式，写明该单元的功能作用（非Form单元必须写）；
在每个单元的接口部分为每个方法写明注释，注释内容包括方法作用、参数含义、返回值含义、作者、编写时间、历次修改说明……；
在业务逻辑复杂的方法中，标明各段代码的业务作用；
在因为界面特殊原因或者操作特殊原因的特殊代码中，要用注释写明为什么要这样写代码，不这么写会有什么后果；




2、变量及方法命名
见名知义、驼峰法，如：ItemIndex、DoSomething()
方法命名要规范成 动词+名词，如一个接口规范名为ABC，其中有登陆接口、数据查询接口1、数据查询接口2，方法名词要命名为：ABC_Login、ABC_QueryData1、ABC_QueryData2。




3、方法及过程编码
方法长度要短；
超过2个地方要重复使用的代码块，要写成独立的方法；
每个方法的开始都需要校验输入参数的合法性，否则返回对应的返回值；
保证业务的分支流程处理严谨；
做好except保护 和 finally资源释放。


4、工程文件命令及管理
单元命名要合理见名知义；
不同功能模块的单元要保存到不同的文件夹中，不能混在一块；