注释是程序开发之中的一项重要组成技术,合理的注释可以使得你们的项目维护更加方便,但是现在很多的公司由于自身的技术管理不到位,很多的注释是不写的,所以就造成了人员交接时的痛苦。
注释的本质在于,编译器在进行程序编译的时候如果发现有注释的内容将不在对此进行编译处理,在Java语言里面对于注释一共有三类形式:
- 单行注释://;
- 多行注释:/* ….*/;
- 文档注释:/*…/,文档注释里面还需要有很多的选项,一般建议通过开发工具控制。
范例:定义单行注释
public class JavaDemo {
public static void main(String [] args){
// 单行注释:下面的语句是进行一行提示信息的输出
System.out.println("Hello World!");
}
}
范例:多行注释
public class JavaDemo {
public static void main(String [] args){
/*
单行注释:下面的语句是进行一行提示信息的输出
XXXX年XX月XX日,XXX改了代码
*/
System.out.println("你好世界!");
}
}
如果在以后使用开发工具开发的时候,还是单行注释会比较方便一些。而对于一些重要的类或者是方法都建议使用文档注释。
范例:文档注释
public class JavaDemo {
public static void main(String [] args){
/*
单行注释:下面的语句是进行一行提示信息的输出
XXXX年XX月XX日,XXX改了代码
*/
//System.out.println("你好世界!");
System.out.println("两个double相乘:"+ String.format("%.2f",doubletoBigDecimal(8.7,0.75)));
}
/*** 这个类返回两个double相乘的结果
* @author pop
* @version 1.0
* @param double,double
*/
public static double doubletoBigDecimal(double d1,double d2){
BigDecimal b1 = new BigDecimal(Double.toString(d1));
BigDecimal b2 = new BigDecimal(Double.toString(d2));
return b1.multiply(b2).doubleValue();
}
}
学习笔记持续更新......
网友评论