锐客网

  1. 首页 > 睿知 > it技术 > >

华为java代码注释模板 java代码的注释怎么写( 二 )

IT技术归云


*/
public class Hello{
/**属性上的注释*/
public String name;
/**这是main方法,是程序的入口
*@param args 用户输入参数
*/
public static void main(String[] args){
System.out.println("Hello World!");
f1();
}
/** 这是第1个方法,其作用是...*/
public static void f1(){
System.out.println("f1()！");
}
}/span
[java] view plain copy
span style="font-size:18px;"import java.io.IOException;
/**javadoc注释内容
*@since 1.0
*@version 1.1
*@author Blue Jey
*br链接到另一个文档{@link Hello},就这些
*see Hello
*/
public class HelloWorld{
/**非public，protected 属性上的注释不生成*/
public String name;
/**这是main方法，是程序的入口
*@param args 用户输入的参数，是数组
*@throws IOException main方法io异常
*/
public static void main(String args[]) throws IOException{
System.out.println("hello World!");
f1();
f2(1);
}
/**这是第一个方法，其作用是....
*@deprecated 从版本1.2开始，不再建议使用此方法
*/
public static void f1(){
System.out.println("fl()!");
}
/**这是第二个方法，其作用是....
*@return 返回是否OK
*@param i 输入参数i
*@see Hello
*@throws IOException io异常
*/
public static String f2(int i)throws IOException{
System.out.println("f1()!");
return "OK";
}
} /span
注意：
如果源文件中有用到@version,@author标记 ， 则在执行javadoc命令时，要加-version -author
javadoc -version -author -d doc *.java
（其中用-version用于提取源文件中的版本信息 -author用于提取源文件中的作者信息）
什么是注释？如何在Java程序中加入注释？试想一下，一个没有一句注释的程序源码，怎么读，一个程序要上万条代码不可能全部记得住哪一块是什么用，而且一个项目也不会是一个人独自完成，那样效率太低，多人合作就要给别人说明，每一块是什么用，方便他人使用，方便自己更正，而这些说明文字就是注释，注释不会被执行，不影响运行结果 。
Java中代码的注释有三种：
// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行，并写入 javadoc 文档
前两种比较容易理解，至于第三种，你学习Java看的api文档就是javadoc程序根据第三种的注释生成的 。
扩展资料
注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码 。注释是编写程序时 ， 写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性 。
【华为java代码注释模板 java代码的注释怎么写】华为java代码注释模板的介绍就聊到这里吧，感谢你花时间阅读本站内容 ， 更多关于java代码的注释怎么写、华为java代码注释模板的信息别忘了在本站进行查找喔 。

推荐阅读


上一篇：宁夏国企招聘小程序开发，宁夏国企校园招聘

下一篇：视频用什么制作封面最好，做视频封面用什么软件好