java后端学习-第一部分java基础：文档注释和代码规范

• 文档注释
  注释内容可以被JDK提供的工具javadoc所解析，生成一套以网页文件形式体现该程序的说明文档，一般写在类

javadoc -d 文件夹名 -xx -yy Demo.java

/**
 * @author  张志伟
 * @version  1.0
 */
public class Comment{
	public static void main(String[] args){
		
	}
}

下面是生成的文件

在浏览器中打开文件

• 代码规范
  1. 类、方法的注释，要以javadoc的方式来写。
  2. 非JavaDoc的注释，往往是给代码的维护者看的，着重告诉读者为什么这么写，如何修改，注意什么问题等。
  3. 使用tab操作，实现缩进，默认整体向右移动，或者使用shift+tab整体向左移动。
  4. 运算符和 = 两边习惯性各加一个空格。如：1 + 1 = 2；
  5. 源文件使用utf-8编码
  6. 行宽度不要超过80字符
  7. 代码编写次行风格和行尾风格，就是{}括号的位置不同