文档下载 文档下载导航
设为首页 | 加入收藏
搜索 请输入内容:  
 导航当前位置: 文档下载 > 所有分类 > IT/计算机 > 计算机软件及应用 > Java注释规范
侵权投诉

Java注释规范

Java注释规范,很详细,很有用。

Java代码注释规范

一、 规范存在的意义

应用编码规范对于软件本身和软件开发人员而言尤为重要,有以下几个原因:

1、好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护;

2、好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码;

3、好的编码规范可以最大限度的提高团队开发的合作效率;

4、长期的规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维;

二、命名规范

1、一般概念

1、尽量使用完整的英文描述符

2、采用适用于相关领域的术语

3、采用大小写混合使名字可读

4、尽量少用缩写,但如果用了,必须符合整个工程中的统一定义

5、避免使用长的名字(小于 15 个字母为正常选择)

6、避免使用类似的名字,或者仅仅是大小写不同的名字

7、避免使用下划线(除静态常量等)

2、标识符类型说明

1、包( Package )的命名

Package 的名字应该采用完整的英文描述符,都是由一个小写单词组成。并且包名的前缀总是一个顶级域名,通常是 com、edu、gov、mil、net、org 等;

如: com.yjhmily.test

2、类( Class )的命名

类名应该是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量保证类名简洁而富于描述。使用完整单词,避免缩写词 ( 除非工程内有统一缩写规范或该缩写词被更广泛使用,像 URL , HTML)

如: FileDescription

3、接口( Interface )的命名

第1页

热门文档

相关文档

  • Java注释规范整理

    Java注释规范整理_IT/计算机_专业资料。Java注释规范Java 注释规范一、背景 1、当我们第一次接触某段代码,但又被要求在极短的时间内有效地分 析这段代码,我们...

  • java注释书写规范

    java注释书写规范_IT/计算机_专业资料。Java 注释书写规范 Javadoc 是 Sun 公司提供的一个技术,它从程序源代码中抽取类、方法、成 员等注释形成一个和源代码...

  • java注释规范

    java注释规范_IT/计算机_专业资料。javadoc 做注释 一. Java 文档 // 注释一行 /* ... */ 注释若干行 /** ... */ 注释若干行,并写入 javadoc 文档...

  • java注释规范

    java注释规范_IT/计算机_专业资料。JAVA注释规范设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开 Comments 节点就是所有需设置...

  • Java注释规范

    Java注释规范_电子/电路_工程科技_专业资料。Java的各种注释,以及写入Javadoc的注释要求对于Java 注释我们主要了解两种: // 注释一行 /* ... */ 注释若干行...

  • java注释规范

    java注释规范_工学_高等教育_教育专区。Java 程序有两类注释:实现注释(implementation comments)和文档注释(document comments)。 实现注释:/*…*/和//,用以注释...

  • java中的注释规范

    java中的注释规范_IT/计算机_专业资料。java中的注释规范JAVA 注释方法及格式 1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释, 注释...

  • javadoc注释规范

    javadoc注释规范_专业资料。javadoc注释规范javadoc 做注释 一. Java 文档 // 注释一行 注释若干行 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法...

  • 注释模板规范_java

    注释模板规范_java_计算机软件及应用_IT/计算机_专业资料。关于java注释模板规范设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后...

站点地图 | 文档上传 | 侵权投诉 | 手机版
本站所有资源均来自互联网,本站只负责收集和整理,均不承担任何法律责任,如有侵权等其它行为请联系我们.
文档下载 Copyright 2013 doc.guandang.net All Rights Reserved.  -  email