文档介绍:Java程序工程规范
为什么要有规范
软件开发是一个集体协作的过程,程序员之间的代码经常进行交换阅读,因此, Java
源程序有一些约定俗成的命名规定, 主要目的是为了提高 Java程序的可读性以及管理上的
方便性。好的程序代码应首先易于阅读,其次才是效率高低的问题。
Java程序编程规范
有多个import语句时,先写java包(都是java包时,按照字母先后顺序排序) 后写javax,最后写其他公司的包和自己定义的包。
命名规则为:
?包名中的字母一律小写, xxxyyyzzz。
?类名、接口名的每个单词的首字母大写,如 XxxYyyZzz。
?方法名第一个单词的首字母小写,后面每个单词的首字母大写,如 xxxYyyZzz。
?常量中的每个字母大写,如 XXXYYYZZZ 。
程序{}强调匹配的同时,要保持适当的缩进,以便于阅读。
必要时应有一定的程序注释量( 20%〜50%),注释内容有程序头说明、属性说
明、方法说明。Java中的注释共有两种方式。
?多行注释:/*文字或程序语句 */。
?单行注释://文字或程序语句。
错误!未找到引用源。注意
多行注释不能嵌套,即/* /*文字或程序语句*/ */是非法的。
帮助文档的自动生成
Java工程规范一方面体现在程序上,另一方面体现在程序帮助文档上,文档的规范和 程序的规范同等重要。 文档规范要求必须具备一定的书写格式以及与程序保持一致。 然而,
要真正实现这一目标并不容易,因为一定的书写格式虽然便于人们之间的沟通,但是却消 耗了程序员宝贵的时间;文档与程序保持一致也并不容易,因为程序可能会经常修改,这 种修改并不都能及时反映到文档中。
要解决上述问题,没有一定的工具是不可能做到的, Sun公司提供的工具javadoc就是
解决这样的问题,javadoc工具的引入,将程序员从枯燥然而又重要的工作中解放出来。 程
序员只要在书写程序时按照一定的要求书写注释,将来就可用 javadoc自动生成帮助文档。 程序员需要注意的规则如下:
程序头说明 注释为“ /**说明部分 */”,在说明部分一般包括文档的标题、
描述、版权、作者、版本等信息。其中作者用 "***@author<作者〉”的形式体现,内容和关
键字之间用空格隔开。其他为 ***@version〈版本>、***@see〈相关内容或类>、***@since〈本内容
在哪个版本以后开始出现 >。
方法说明 用于说明本方法的主要用途,实现的基本思路,属性信息有 ***@param 〈属性名称 >〈参数说明>、***@return〈返回值说明>、***@exception〈例外说明>、***@throws〈异 常类>、***@deprecated〈功能逐渐被淘汰说明>。
如果按照上面的方式书写注释,则它们可以反映到帮助文档中。
【]
import . *;
import . *;
/ **
*Title: 这是一个演示程序<br>
*Description: 用于说明Applet 程序的典型特征<br>
****@author 无名氏
****@version
*/
public class HelloWorldApplet extends Applet
(
/ **初