Java软件开发文档代码规范

所需积分/C币:50 2015-12-28 18:50:00 172KB PDF
125
收藏 收藏
举报

java课程资料,开发文档代码的规范,请需要的人下载,可以免费传播!
变量的名字必须用一个小写字母开头。后面的单词用大写字母开头 变量的命名 变量的名字应该都大写,并且指出完整含义 参数的命名 参数的名字必须和变量的命名规范一致。 数组的命名 数组应该总是用下面的方式来命名: 而不是: 方法的参数 使用冇意义旳参数命名,如果可能的话,使用和要赋值的字段一样的名字: 文件样式 所有的 文件都必须遵守如下的样式规则 版权信息 版权信息必须在文件的开头,比如: 其他不需要出现在 的信息也可以包含在这里。 行要在 行之前, 中标准的包名要在本地的包名之前,而且按照字母 顺序排列。如果 行中包含了同一个包中的不同子目录,则应该用来处理。 这里 使用来代替 的 接下来的是类的注释,一般是用来解释类的 接下来是类定义,包含了在不同的行的 和 接下来是类的成员变量 的成员变量必须生成文档( 和 定义的成 员变量如果名字含义明确的话,可以没有注释。 存取方法 接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话,可以简咩的 写在一行上。 其它的方法不要写在一行上 构造函数 接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面) 访问类型 等和任何 或 应该在行 中,并且方法和参数另写一行,这样可以使方法和参数更易读 克隆方法 如果这个类是可以被克隆的,那么下一步就是 方法 类方法 下面开始写类的方法: 方法 无论如何,母个类都应该定义 方法: 方法 如果 方法已经定义了那么亡应该写在类的底部 软件开发过程中代码的可读性 避免使用不易理解的数字,用有意义的标识来替代。 不要使用难懂的技巧性很高的语句 源程序中关系较为紧密的代码应尽可能相邻。 软件开发过程中代码的性能 在写代码的时侯,从头至尾都应该考虑性能问题。这不是说时间都应该浪费在优化代码上, 而是我们吋刻应该提醒自凵要注意代码的效率。比如:如果没有时间来实现个高效的算法, 那么我们应该在文档中记录下来,以便在以后有空的时候再来实现她。 不是所有的人都同意在写代码的时候应该优化性能这个观点的,他们认为性能优化的问题应 该在项目的后期冉去考虑,也就是在程序的轮廓已经实现∫以后 不必要的对象构造 不要在循环中构造和释放对象 使用 对象 在处理 的时候要尽量使用 类 类是构成 类的基础 类将 类封装」起来,(以花费史多时间为代价)为开发人员提供了一个 安全的接口。当我们在构造字符串的时候,我们应该用 来实现大部分的工作, 当工作完成后将 对象再转换为需耍的 对象。比如:如果有一个字符串 必须不断地在其后添加许多字符来完成构造,那么我们应该使用 对象和她的 方法。如果我们用 对象代替 对象的话,会花费许多不必要的 创建和释放对象的时间。 避免太多的使用 关键字避免不必要的使用关键字 ,应该在必要 的时候再使用她,这是一个避免死锁的好方法。 软件开发的编程技巧 数组转换到 为了将数组转换到 ,你可以这么做: 类 类(仅仅提供方法的类〕应该被申明为抽象的来防止被继承或被初始化。 初始化 下面的代码是一种很好的始化数组的方法 枚举类型 对枚举的支持不好,但是下面的代码是种很有用的模板: 这种技术实现了 等可以象其他语言的枚举类型样使用的常量。 他们可以用操作符来比较 但是这样使用有一个缺陷:如果一个用户用这样的方法来创建颜色 那么这就是另外一个对象,操作符就会产生错误。她的 方法仍然有效。由于这 原因,这个技术的缺陷最好注明在文档中,或者只在自已的包中使用。 代码编写格式 代码样式 代码应该用 的格式,而不是 的(比如:回车变成回车换行) 文档化 必须用 来为类生成文档。不仅因为它是标准,这也是被各种编详器都认可的 方法。使用 标记是不被推荐的,因为代码不应该是破个人拥有的。 缩进 缩进应该是每行个空格不要在源文件中保存字符在使用不同的源代码管理工具时 字符将因为用户设置的不同而扩展为不同的宽度如果你使用 作为你的 源代码编辑尜的话,你可以通过如下操作来禁止保存字符方法是通过 中先设 定使用的长度室个空格,然后用 来单将转换为空格。 页宽 页宽应该设置为字符源代码一般不会超过这个宽度并导致无法完整显示但这一设置 也可以灵活调整在任何情况下超长的语句应该在一个逗号或者一个操作符后折行一条 语句折行后应该比原来的话句再缩进个字符 对 中的语句应该单独作为一行例如下面的第行是错误的第行是正确的 错误和在同 正确单独作为一行 语句永远单独作为一行 如果语句应该缩进到与其相对应的那一行相对齐的位置。 括号 左括号和后一个字符之间不应该出现空格同样右括号和前一个字符之间也不应该出现空 烙下面的例子说明括号和空柊的错炇正确使用 错误 正确 不要在语句中使用无意义的括号括号只应该为达到某种目的而出现在源代码中。下面的例 子说明错误和正确的用法 错误括号毫无意义 正确的确需要括号 、代码编译 编写代码时要注意随时保存,并定期备份,防止由于断电、硬盘损坏等原因造成 代码丢失 同一项日组内,最好使用相同的编辑器,并使用相同的设置选项。 合理地设计软件系统目录,方便开发人员使用。 打开编译器的所有告警开关对程序进行编译。 在同一项目组或产品组中,要统一编译开关选项。 使用软件开发工具(如 )对代码版本进行维护。 开发出软件的可移植性 不喜欢 这个关键字,如果你的断点设在这些关键字的作用域 内的话,调试的时候你会发现的断点会到处乱跳,让你不知所措。除非必须,尽量不要使用。 换行 如果需要换行的话,尽量用 来代替在字符串中使用 你不要这样: 要这样: 或者你构造一个带换行符的字符串,全少要象这样: 已经被不赞成 )使用,用 来代替它。

...展开详情
试读 8P Java软件开发文档代码规范
立即下载
限时抽奖 低至0.43元/次
身份认证后 购VIP低至7折
一个资源只可评论一次,评论内容不能少于5个字
您会向同学/朋友/同事推荐我们的CSDN下载吗?
谢谢参与!您的真实评价是我们改进的动力~
上传资源赚钱or赚积分
最新推荐
Java软件开发文档代码规范 50积分/C币 立即下载
1/8
Java软件开发文档代码规范第1页
Java软件开发文档代码规范第2页

试读结束, 可继续读1页

50积分/C币 立即下载