软件编程规范总则1

 软件编程规范总则1

 

排版规则:

      1. 程序块要采用缩进风格编写;
      2. 相对独立的程序块之间、变量说明之后必须加空行,如:

 

     3.      较长的语句( >80字符 )要分成多行书写,长表示式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,

              使排版整齐,语句可读,如:

                             

     4.     不允许把多个短语句写在一行中,即一行只写一条语句,如:

                                  

     5.      if、for、do、while、case、switch、default 等语句自占一行,如:

                               

    6.      在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的

             立即操作符,后不应加空格,如:

                             

  注释规则:

                  1.   一般情况下,源程序有效注释量必须在20%以上。

                               2.   说明性文件( 如头文件 .h 文件)头部应注释,源文件头部、函数头部应进行注释。

                              3.  边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。

                              4.  注释的内容要清楚、明了,含义准确,防止注释有歧义。

                              5.  注释应与其描述的代码相近,对代码的注释应放在其上方或右方( 对单条的注释 )相邻位置,不可放在下面,如放于上方则需与上面用空行隔开。

                             6.  对于所有有物理含义的变量、常量,如果其命名不是充分自注释,在声明时都必须加以注释,说明其物理含义。

                            7.  注释与所描述的内容进行同样的缩排。

                            8.   在程序块的结束行右方加注释标记,以表明某程序块的结束。

                            9.   注释应考虑程序的易读性及外观排版因素,使用的语言若是中、英文兼有时,建议多使用中文。

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值