Java命名规范及给自己写的方法添加注解

转自：http://blog.csdn.net/sunnyfans/article/details/8006084

主题：

如何给自己写的方法增加简洁的注解，便于以后自己使用，
不至于忘了方法里面的参数是干什么用的！


想要给自己写方法添加注解，那先保证自己写的方法得规范，不然面子往那搁，于是网上查阅了相关的资料，看到一篇好帖，在此给大家分享下，原文如下请点击：必须掌握Java命名规范
在此摘抄下：
1、包名：包名由小写英文字母组成。
为了保障每个Java包命名的惟一性，最新的Java编程规范要求程序员在自己定义的包的名称之前加上惟一的前缀。由于互联网上的域名是不会重复的，所以程序员一般采用自己在互联网上的域名作为自己程序包的惟一前缀。例如：net.frontfree.javagroup。
2、类名：类名必须用大写英文字母开头，多单词组合时单词首字母用大写，单词其他字母用小写。
如果类名称由多个单词组成，则建议将每个单词的首字母均用大写，例如TestPage。如果类名称中包含单词缩写，则建议将这个词的每个字母均用大写，如：XMLExample。由于类是设计用来代表对象的，所以建议在命名类时应尽量选择名词。例如：NameStandardTest。
3、常量名：常量用final来修饰，表明一般情况下，代码中只用它而不能再改变它的值。

    常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则建议用下划线来分割这些单词。

    例如：MAX_VALUE。

4：方法名：一般首单词首字母用小写英文，其他单词首字母用大写。

    方法的名字的第1个单词应以小写字母开头，后面的单词则建议用大写字母开头。

    例如：sendMessge()。

5：参数名：与方法名规范相同。
参数的命名规范和方法的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证在参数名称为一个单词的情况下，参数的命名尽可能明确。例如：methodTest(String stringName)。

6:   注释

Java除了可以采用常见的注释方式之外，Java语言规范还定义了一种特殊的注释，也就是通常所说的Javadoc注释，它是用来记录代码中的API的。Javadoc注释是一种多行注释，以/**开头，而以*/结束，注释可以包含一些HTML标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以被自动转化为在线文档，省去了单独编写程序文档的麻烦。例如：

/**
*This is an example of
* Javadoc
*
*@author darchon
*@version 0.1, 10/11/2002
*/

在每个程序的最开始部分，一般都用Javadoc注释进行程序的总体描述以及版权信息。在主程序中可以为每个类、接口、方法、变量添加Javadoc注释，每个注释的开头部分先用一句话概括该类、接口、方法、变量所完成的功能，这句话应单独占据一行以突出其概括作用，在这句话后面可以跟随更加详细的描述段落。


在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落，例如上面例子中的@auther和@version，这些段落将在生成的文档中以特定方式显示。


虽然添加注释不会使一个设计低劣的程序变成好的程序，但是如果按照编程规范编写程序，并且为程序添加良好的注释，却可以帮助编写出设计优美、运行高效且易于理解的程序，尤其在多人合作完成同一项目时，编程规范非常重要。俗话说"磨刀不误砍柴工"，花费一点时间去适应一下Java编程规范是有好处的。




小结：
下面写了一个demo特意来熟悉下给方法添加注释，试试效果看。
以后在写方法时要给方法加注释，这样会提醒自己，明确
写此方法的目的，做它该做的事，是否还有其他因素需要考虑。
理论联系实践，实践更新理论，在实践中不断完善自己。