Java学习笔记（三）

一、注释（注解说明解释程序的文字）

1、单行注释

基本格式：//注释文字

2、多行注释

基本格式：/*注释文字*/

1/2使用细节：

（1）被注释的文字不会被JVM（java虚拟机）解释执行

（2）多行注释里面不允许有多行注释嵌套

/* 注释 /* 注释内容*/ 注释  */是不被允许的，编译器会报错

3、文档注释（注释内容可被javadoc解析，生成一套以网页文件形式体现的该程序的说明文档，一般写在类）

（1）基本格式

/**

    *@author 小明

   *@version 1.0

*/

@后面的标签不是随便使用的，有一定要求

（2）应用实例

javadoc-d文件名-xx-yy Demo3.java

-d代表要把生成的文档放到对应的目录中去

-x-yy代表生成哪些对应的javadoc标签

Demo3代表对哪一个文件来做javadoc的生成

写上才能生成

示例：

D：\javacode>javadoc-d d:\\temp-author-version Comment02.java

二、代码规范

1、类、方法的注释，要以javadoc的方式来写，即文档注释表述。

2、非javadoc的注释（单行注释或者多行注释），往往是给代码的维护者看的，着重告诉读者为什么这样写，如何修改，注意什么问题等

3、选中，使用tab操作，实现缩进，整体向右边移动；

      或选中，用shift+tab整体向左移动

4、运算符和=两边习惯性各加一个空格。

比如：2 + 4 * 5 + 345 - 89 ；

5、源文件使用utf-8编码

6、行宽度不要超过80字符（显得更简洁）

7、代码编写次行风格和行尾风格（！！）

两种风格均可，但推荐使用行尾风格

行尾打大括号，然后换行再输入跟它匹配的大括号（行尾风格）

换行输入大括号，然后输入内容，再换行输入跟它匹配的大括号（次行风格）