软件开发编规范.docVIP

广西移动经营分析系统编程规范 1．编程风格 所谓编程风格实际上就是编程习惯，它包含两个层次的概念：编码格式和语言运用。本规范所涉及的主要是编码格式的有关范畴：注释规范、命名规则、代码风格。 好的编程风格，必须具备清楚的注释、良好的命名习惯；没有注释、变量随意命名，是编程之大忌，这样写出的代码，行数多了以后有时甚至连编程人员自己都无法看懂，可读性无所谈起。实际编程中，常常会因使用的语言、开发工具、操作系统不同而编码风格会有所不同，我们应尽量保持与开发语言、工具的风格相一致，同时也要保持自己既定的风格。有了自己既定风格的编码，当代码在不同的语言或不同的操作系统平台移值时，可读性强，易于理解。 2．适用范围 本文的规范在原则上适用于oracle的编写，使用其它编程语言（如Java、Delphi、VB等）时仅供参考。 3．注释规范 3.1注释原则 1、尽量使用中文注释，以便于理解，防止歧义性。 2、在保证意思表达清楚的基础上，尽可能简洁，节约书写和阅读的时间。 3、尽可能语义完整、清晰，书写工整、对齐。 4、在编码的过程中，及时注释，特别是一些关键算法或重要操作处，修改代码同时修改注释，保证代码和注释一致。 5、注释中最好包括作者和日期，特别是在修改他人代码的时候。 6、注释要写在被注释代码的上方或右侧，不得写在下方。 7、添加注释以有利于理解代码为原则，有必要之处才添加，注释不是文档，过多或过少均不可取。 8、注释符的使用，整段注释用“/*”和“*/”包括；单行注释使用“//”。 3.2文件注释 开发人员自己创建的文件（开发工具自动生成除外），在头文件和实现文件中都应写上文件注释，格式如下： /* --------------------------------------------------------------------------------- 版权声明：版权所有、开发起止年份、公司名称、权利保留 文件名： 作者： 版本号： 创建日期： 描述说明： -------------------------------------------------------------------------------- */ 示例： /* ----------------------------------------------------------------------------- Copyright (C) , XXXXXXX File name : XXX.SH Author : XXX Version : 0.1 Date : 2008.5.22 Description : XXXXX ----------------------------------------------------------------------------- */ 3.3变量注释 对于自定义的一些重要变量（含全局变量、实例变量、类成员变量、局部变量等），在定义时要加以注释，尽可能说明其用途、作用域、可能值的变化范围等；变量定义的声明，尽可能集中放在文件或函数的顶部，尽量减少在代码行中间随意定义；通用变量的定义可视情况而定，但要尽量遵循上述定义规则，保证书写的工整性、可读性。 注：通用变量泛指大家约定俗成习惯使用的变量，如循环控制变量(i，j)等。 3.4代码注释 1、重要变量赋值时，应当加以注释说明。 2、代码逻辑控制流程、用于流程控制的变量、信号量、事件等必须加注释说明。 3、代码中完成某一逻辑功能的代码段，须加以注释说明。 4、程序代码中调用子函数之前，应加注调用该函数作用的注释说明；除非被调用子函数从名称上可明确识别其用途，则可不加注释。 4．代码风格 4.1代码书写原则 1、注释和代码分别尽量对齐，力求整洁、美观。 2、语句不宜过长，当语句过长时，按逻辑功能的不同或字符分段原则将其分行书写，分行同时应兼顾字符对齐，保持格式的统一。 3、单行代码尽量简洁，保证代码易阅读，方便加注释，如只写一条语句，只定义一个变量。 4、if、for 、while、 do、 switch case等语句单独占用一行，“{”和执行语句都不得紧跟其后，为保证美观和防止书写失误，无论执行语句多少行，即使是只有一行，都必须用“{ }”将语句包含。 4.2对齐和缩进 1、关键字（如if、for、while等）和“{” 、“}”都单独占用一行，与其并列语句左对齐，并且位于同一列。 2、“{ }”之内的子代码块在“{”右边水平缩进4个空格对齐。 3、代码文件的编写原则是从最左边界开始书写对齐，最顶层“{ }”中的所有代码段都按上述两点原则逐级缩进。 4