java软件开发文档代码规范

《java软件开发文档代码规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、俗话说无规矩不成方圆，在现实生活中，不管我们做什么事都讲究规则，软件开发也一样，无论你在什么样的软件开发公司，无论你从事安卓软件开发还是手机软件开发，都必须要遵循软公司的规则，软件开发的规则，行业的规则；我们只有遵循这些规则，有一个好的软件开发流程，才能一直很好的走下去，才能有进步，下面我和大家共同探讨一下软件开发的规则，也就是说我们开发一个软件需要满足哪些要求；有不中之处还望大家多多指点：(由于本人重点从事Java软件开发，所以重点说的是Java软件开发的规则，大同小异了)1、代码组织与风格(1).关键词和操作符之间加适当的空格。(2).相对独立的程序块与块之间加空

2、行(3).较长的语句、表达式等要分成多行书写。(4).划分出的新行要进行适应的缩进，使排版整齐，语句可读。(5).长表达式要在低优先级操作符处划分新行，操作符放在新行之首。(6).循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分。(7).若函数或过程中的参数较长，则要进行适当的划分。(8).不允许把多个短语句写在一行中，即一行只写一条语句。(9).函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。2、软件开发中的注解定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不

3、是一定要绝对遵守，但是一定要让程序有良好的可读性）。Java的语法与C++及为相似，那么，你知道Java的注释有几种吗？是两种？//注释一行/*......*/注释若干行不完全对，除了以上两种之外，还有第三种，文档注释：/**......*/注释若干行，并写入javadoc文档注释要简单明了。StringuserName=null;//用户名边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准确，防止注释二义性。保持注释与其描述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻位置

4、，不可放在下面。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释应放在此域的右方；同一结构中不同域的注释要对齐。变量、常量的注释应放在其上方相邻位置或右方。全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；生成日期；模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等）；主要函数或过程清单及本文件历史修改记录等。/***CopyRightInformation:NeusoftIIT*Project:eTra

5、in*JDKversionused:jdk1.3.1*Comments:configpath*Version:1.01*Modificationhistory:2003.5.1*SrDateModifiedByWhy&Whatismodified*1.2003.5.2KevinGaonew**/在每个函数或过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等/***Description:checkout提款*@paramHashtablecartinfo*@paramOrderBeanorderinfo*@

6、returnString*/publicStringcheckout(HashtablehtCart,OrderBeanorderBean)throwsException{}javadoc注释标签语法@author对类的说明标明开发该类模块的作者@version对类的说明标明该类模块的版本@see对类、属性、方法的说明参考转向，也就是相关主题@param对方法的说明对方法中某参数的说明@return对方法的说明对方法返回值的说明@exception对方法的说明对方法可能抛出的异常进行说明3、软件开发中的命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的

7、，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）较短的单词可通过去掉"元音"形成缩写；要不然最后自己写的代码自己都看不懂了，那可不行。较长的单词可取单词的头几发符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。使用匈牙利表示法Package的命名Package的名字应该都是由一个小写单词组成。packagecom.neu.utilClass的命名Class的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首