03Java学习_注释和代码规范

发布时间 2023-09-07 10:43:29作者: 彬彬zhidao

注释和代码规范

注释

注释介绍

用于注解说明解释程序的文字就是注释,注释提高了代码的阅读性(可读性);注释
是一个程序员必须要具有的良好编程习惯。将自己的思想通过注释先整理出来,再用
代码去体现。

单行注释

基本格式:

双斜杠://

int a=100;
// 定义变量,这个是一个单行注释

多行注释

基本格式:

斜杠星:/**/

  • 多行注释中不能嵌套多行注释。
int b = 20;
/*
多行注释内容
1234
534
*/

文档注释

javadoc基本格式:

/**
	* @author   binbin
	* @version  1.0
**/

应用实例:

javadoc -d e:\\doc -author -version text.java

实操:

image-20230907102139929

image-20230907102253621

打开index.html

image-20230907102415795

文档注释使用的还是很多的

代码规范

  1. 类、方法的注释要以javadoc的方式来写。
  2. 非Java Doc的注释,往往是给代码的维护者看的,着重描述告诉读者为什么这样写。
  3. 选中,然后按tab键盘整体右移动。tab + shift 键盘整体左移动。
  4. 运算符和 = 两边习惯性各加一个空格。比如2 + 4 * 5 + 345 - 89
  5. 源文件使用utf-8编码。
  6. 行宽不要超过80个字符。
  7. 代码编写 次行风格行尾风格
次行风格:
for()
{

}
行尾风格:
for(){

}