- 命名规范
- 变量定义
用int[] packets,永远不要用 int packets[]形式
- 代码编写
样式推荐用unix格式——回车+换行
javadoc文档化
缩进2个字符(不要用tab,避免不同的代码管理工具tab设置不同)
不加无意思的括号,{ }分两行
- 全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
- 注释规范
3种形式——// 注释一行
/*……*/ 注释若干行
/**……*/ 文档注释,写入javadoc
注释放在上方或右方
整个源文件要有详细的注释
每个函数前有必要的注释
javadoc注释标签语法:
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说
-
函数
保证每个参数的有确切含义。
exit只能在main中被调用
顶层的main应该截获所有异常,并且打印到屏幕或记录日志
如果不确定某类是否要被继承,在文档中注明,不轻易定义为final
-
*. java文件应该遵循的样式(主要包含以下部分)
版本信息放在java文件开头,形式为(其他不要出现在javadoc中内容也可以包含其中)
package放在import之前,import标准 放在 import本地 之前。
类注释
类定义
类成员变量(public 成员变量必须生成javadoc)
存取方法(如果很简单可以写在同一行)
构造函数
类方法
toString方法(每个类都应该有toString方法)
main方法(如果有main方法,应写在类的最底部)
-
注意一些性能
不要再循环中构造变量 或 释放变量
相关推荐
在Java编程世界里,遵循...总之,遵循"JAVA编程规范"能帮助开发者编写出高质量、易于理解和维护的代码,这对于个人和团队的长期发展都是极其有益的。在实践中不断学习和适应这些规范,将使你的Java编程技能更加专业。
《Java编程规范(第3版)》是一本深入探讨Java编程语言最佳实践、代码风格、设计模式以及编码标准的专业书籍。对于任何希望提高其Java编程技能、编写可维护且高效代码的开发人员来说,这本书都是不可或缺的资源。...
遵循《JAVA编程规范.pdf》中详述的编码规范,不仅能提升个人编码质量,还能增强团队协作效率,减少后期维护成本。规范的代码不仅易于理解和维护,也是软件工程师专业素养的体现。通过实施统一的编码规范,可以显著...
### Java编程规范详解 #### 1. 引言 ##### 1.1 为何需要编码规范 在软件开发过程中,编码规范(Code Conventions)扮演着至关重要的角色。据研究显示,一个软件产品的生命周期内大约80%的成本投入在维护阶段。这...
### Java编程规范重要性及其实践 #### 一、引言 在软件开发过程中,编程规范起着至关重要的作用。良好的编程规范不仅能够提高代码的可读性和可维护性,还能帮助团队成员更快地理解彼此的代码,从而提高整体的开发...
Java编程规范是针对Java语言开发中代码书写习惯、格式、命名及注释等方面的统一标准和要求。遵循规范的目的是为了增强代码的可读性和一致性,减少因团队成员更换或多人协作时可能出现的理解偏差,从而提高项目的开发...
本资源包包含了多个文档,详细阐述了不同层面的Java编程规范,包括个人博客链接和华为软件公司的编程规范,以及相关的编程规范试题。这些资料将帮助开发者深入理解并遵循最佳实践。 首先,`java语言编程规范.doc`...
### JAVA编程规范详解 #### 一、概述 Java作为一种广泛使用的编程语言,其规范的编写对于提高代码质量、增强团队协作以及确保项目的长期可持续发展至关重要。《JAVA编程规范v1.0.doc》文档旨在为遵循J2EE标准的...
《JAVA编程规范化》旨在为项目中的所有文档制定统一的标准,使它们看起来像是同一个人所写,从而增强代码的可读性和维护性。本文将详细介绍JAVA编程规范化的要求,包括命名规则、文件样式、代码编写样式等内容。 ##...
《Java编程规范 中文版》是一本旨在提升Java开发者编程能力的重要参考资料,它详细阐述了在Java编程中应遵循的最佳实践和标准。这份规范不仅帮助新手程序员建立良好的编程习惯,也对经验丰富的开发者提供了有价值的...
阿里Java编程规范是Java开发者的重要指南,旨在提升代码质量,增强团队协作效率,以及确保软件的稳定性和可维护性。这份规范由阿里巴巴集团制定并不断更新,被广泛应用于其内部项目,同时也对整个Java社区产生了深远...
根据提供的文件信息,我们可以总结出一系列关于Java编程规范的关键知识点。这些规范对于编写高质量、可维护性强的Java代码至关重要。 ### Java编程规范概览 #### 1. 类和方法命名规则 - **类名**: 遵循驼峰命名法...
### Java编程规范详解 #### 一、引言 在软件开发过程中,良好的编程规范...以上是对给定文档中部分内容的深入解析与扩展,旨在帮助读者更好地理解和掌握Java编程规范,从而提升个人技能并在实际项目中应用这些规范。
学习并遵循Java编程规范,不仅可以提升个人编程技能,还能帮助团队协作更加顺畅,降低维护成本。在准备考试或进行项目开发时,理解并熟练运用这些规范至关重要。因此,"Java编程规范 考试 知道 教程 文档"的资源是...
### Java编程规范详解 在Java开发领域中,遵循一套完整的编程规范对于提高代码质量、增强团队协作效率至关重要。本文将基于“Java编程规范大全”这一主题进行深入探讨,旨在为开发者提供一个全面的指南,帮助大家更...
Java编程规范是编程界的一本经典著作,旨在帮助开发者遵循一套统一的标准,提高代码质量,增强可读性,便于团队协作。以下是对标题、描述以及标签的详细解释和相关知识点的扩展: 标题:“Java编程规范 完美 实用”...
**Java编程规范** Java编程规范是一份详细的指南,旨在提高代码质量、可读性和可维护性,确保开发团队之间的统一编码风格。这份规范由北京京安丹灵科技有限公司编制,经历了多次修订,如V1.0和V1.0.1,以适应不断...
Java编程规范是软件开发中的一项重要指南,旨在提高代码质量,增强可读性,并促进团队间的有效合作。规范不仅帮助开发者编写出易于理解和维护的代码,还能减少因个人编程风格差异导致的沟通成本,尤其在大型项目或...