试想一下,一个没有一句注释的程序源码,怎么读,一个程序要上万条代码不可能全部记得住哪一块是什么用,而且一个项目也不会是一个人独自完成,那样效率太低,多人合作就要给别人说明,每一块是什么用,方便他人使用,方便自己更正,而这些说明文字就是注释,注释不会被执行,不影响运行结果.
Java中代码的注释有三种：
// 注释一行?
/* ...... */ 注释若干行?
/** ...... */ 注释若干行,并写入 javadoc 文档
前两种比较容易理解,至于第三种,你学习Java看的api文档就是javadoc程序根据第三种的注释生成的.
扩展资料
注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码.注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性.
①.、单行注释? //注释的内容
下面介绍一下Javadoc的标记：
特别声明：
（1）javadoc针对public类生成注释文档
下面主要举例说明第三种注释的应用：
（1）首先编写.java文件
javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档
附上代码：
[java]?view plain?copy
/**javadoc注释的内容
*/
public?class?Hello{
/**属性上的注释*/
public?String?name;
/**这是main方法,是程序的入口
public?static?void?main(String[]?args){
System.out.println("Hello?World!");
f1();
}
/**?这是第1个方法,其作用是...*/
public?static?void?f1(){
System.out.println("f1()！");
}/span
/**javadoc注释内容
*see?Hello
public?class?HelloWorld{
/**非public,protected?属性上的注释不生成*/
public?static?void?main(String?args[])?throws?IOException{
System.out.println("hello?World!");
/**这是第一个方法,其作用是....
System.out.println("fl()!");
/**这是第二个方法,其作用是....
System.out.println("f1()!");
return?"OK";
}?/span
注意：
javadoc?-version?-author?-d?doc?*.java
①.、单行(single-line)--短注释：//......
单独行注释：在代码中单起一行注释,
注释前最好有一行空行,并与其后的代码具有一样的缩进层级.如果单行无法完成,则应采用块注释.
注释格式：/*
注释内容
行头注释：在代码行的开头进行注释.主要为了使该行代码失去意义.
注释格式：//
注释格式：代码
+
//
注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述.一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置.这种域注释不会出现在HTML报告中.注释格式通常写成：
/*
*
注释若干行,并写入javadoc文档.每个文档注释都会被置于注释定界符
/**......*/
...
java代码注释快捷键：ctrl+shift+/
首先熟悉一下html、css、js的注释的写法：
①.、HTML注释语法：
!--注释的内容--
/* 注释内容 */
/* ----------文字样式开始---------- */
//注释内容
/*注释内容*/
此时此刻呢是对注释在这几种代码中使用的位置,如何写注释进行最后提醒一下大家.（根据个人的习惯可能不一样）
写代码的时候,有时候,你需要写一些注释,把内容相互关联起来,方便自己或别人看的时候,可以直接找到你关联的代码类或者啥的.
不管他具体有什么功能,咱就只管一个,他可以链接代码,让注释看的更清楚易懂.方便你我他.
@see 标签允许用户引用其他类的文档.具体使用方式如下：
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称
我在使用的时候,发现这个只能单独一行顶头写,如果不顶头写就不管用了,没了链接的效果.
实际效果,看下面的图
注释是用来给开发者或者是软件后续的维护者来看的.一般是用来描述这一段代码或者是程序做了些什么样的事情.实现了哪些功能,java里面注释代码,可以分为行注释和块注释,方法注释等.
行注释就是在需要注释的代码前加 //
块注释则是用 /* 和 */ 把文本段落框起来即可
以上就是土嘎嘎小编为大家整理的java怎么给代码注释相关主题介绍,如果您觉得小编更新的文章只要能对粉丝们有用,就是我们最大的鼓励和动力,不要忘记讲本站分享给您身边的朋友哦！！