良好的编程习惯 (五)变量与结构(1)
15-1 :去掉没必要的公共变量。
说明:公共变量是增大模块间耦合的原因之一,故应减少没必要的公共变量以降低模块间
的耦合度。
说明:在对变量声明的同时,应对其含义、作用及取值范围进行注释说明,同时若有必要
还应说明与其它变量的关系。
说明:明确过程操作变量的关系后,将有利于程序的进一步优化、单元测试、系统联调以
及代码维护等。这种关系的说明可在注释或文档中描述。
示例:在源文件中,可按如下注释形式说明。
RELATION System_Init Input_Rec Print_Rec Stat_Score
Student Create Modify Access Access
Score Create Modify Access Access, Modify
注:RELATION 为操作关系;System_Init、Input_Rec、Print_Rec、Stat_Score
为四个不同的函数;Student、Score 为两个全局变量;Create 表示创建,Modify 表
示修改,Access 表示访问。
其中,函数 Input_Rec、Stat_Score 都可修改变量Score ,故此变量将引起函数间较
大的耦合,并可能增加代码测试、维护的难度。
15-4 :当向公共变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。
说明:对公共变量赋值时,若有必要应进行合法性检查,以提高代码的可靠性、稳定性。
15-5 :防止局部变量与公共变量同名。
说明:若使用了较好的命名规则,那么此问题可自动消除。