java代码注释一般格式 java中代码注释有哪些-乐山大橙子建站

新闻中心

这里有您想知道的互联网营销解决方案

java代码注释一般格式 java中代码注释有哪些

java注释若干行的格式

注释：//表示注释一行。

创新互联建站是一家专注于网站设计、做网站与策划设计,洮北网站建设哪家好?创新互联建站做网站,专注于网站建设十年,网设计领域的专业建站公司;建站业务涵盖:洮北等地区。洮北做网站价格咨询:18980820575

/*表示注释段内容（可以为很多行）*/

public static void main(String [] args){

System.out.println("Hello World1");

//System.out.println("Hello World2");

System.out.println("Hello World3");

/*System.out.println("Hello World4");

System.out.println("Hello World5");/*

}

这样的话就只会输出：

Hello World 1

Hello World 3

这样很好理解吧？

想编写优美的java代码格式要记住这几条规则

做到这些规则的目的很简单，就是写出“优美”的Java代码来。

1、Java注释尽可能全面

对于方法的注释应该包含详细的入参和结果说明，有异常抛出的情况也要详细叙述：类的注释应该包含类的功能说明、作者和修改者。

2、多次使用的相同变量最好归纳成常量多处使用的相同值的变量应该尽量归纳为一个常量，方便日后的维护。

3、尽量少的在循环中执行方法调用尽量在循环中少做一些可避免的方法调用，这样可以节省方法栈的创建。例如：

for（int i=0;ilist.size（）；i++）{

System.out.println（i）；}可以修改为：

for（int i=0,size=list.size（）；isize;i++）{

System.out.println（i）；}4、常量的定义可以放到接口中在Java培训中，接口里只允许存在常量，因此把常量放到接口中声明就可以省去public static final这几个关键词。

5、ArrayList和LinkedList的选择这个问题比较常见。通常程序员最好能够对list的使用场景做出评估，然后根据特性作出选择。ArrayList底层是使用数组实现的，因此随机读取数据会比LinkedList快很多，而LinkedList是使用链表实现的，新增和删除数据的速度比ArrayList快不少。

6、String,StringBuffer和StringBuilder 这个问题也比较常见。在进行字符串拼接处理的时候，String通常会产生多个对象，而且将多个值缓存到常量池中。例如：

String a=“a”;

String b=“b”;a=a+b;这种情况下jvm会产生“a”,“b”,“ab”三个对象。而且字符串拼接的性能也很低。因此通常需要做字符串处理的时候尽量采用StringBuffer和StringBuilder来。

7、包装类和基本类型的选择在代码中，如果可以使用基本数据类型来做局部变量类型的话尽量使用基本数据类型，因为基本类型的变量是存放在栈中的，包装类的变量是在堆中，栈的操作速度比堆快很多。

8、尽早的将不再使用的变量引用赋给null 这样做可以帮助jvm更快的进行内存回收。当然很多人其实对这种做法并不感冒。

java 文档注释是注释什么的,不是有多行注释了吗?

1、【文档注释】是写在类或者方法的上面的。

文档注释可以用eclipse导出chm格式的帮助文档，拿给其他人用时，方便他人理解。文档注释被调用的方法，当鼠标移到上面时提醒注释内容。

使用文档注释时，需要在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。

之后，可以包含一个或多个何种各样的@ 标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。

2、【多行注释】注释的也是方法或类，言下之意就是一次性的将程序中的多行代码注释掉，但多行注释的内容不能用于生成一个开发者文档。

3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档，而文档注释的内容可以生产一个开发者文档。

扩展资料

java常用的文档注释标签

1、@author：标识一个类的作者

实例： @authordescription

2、@deprecated：指名一个过期的类或成员

实例： @deprecateddescription

3、@exception：标志一个类抛出的异常

实例：@exceptionexception-nameexplanation

4、{@inheritDoc}：从直接父类继承的注释

实例：Inheritsacommentfromtheimmediatesurperclass.

5、{@link}：插入一个到另一个主题的链接

实例：{@linknametext}

6、{@linkplain}：插入一个到另一个主题的链接，但是该链接显示纯文本字体

实例：Insertsanin-linelinktoanothertopic.

7、@param：说明一个方法的参数

实例：@paramparameter-nameexplanation

8、@return：说明返回值类型

实例：@returnexplanation

9、@see：指定一个到另一个主题的链接

实例：@seeanchor

10、@serial：说明一个序列化属性

实例：@serialdescription

参考资料：百度百科-java注释

java 中的几种注释方式

我看动力节点的java基础大全301集教中的三种注释方法：

1、单行注释 //注释的内容

2、多行注释 /*......*/

3、/**......*/，这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。

下面介绍一下Javadoc的标记：

特别声明：

（1）javadoc针对public类生成注释文档

（2）javadoc只能在public、protected修饰的方法或者属性之上

（3）javadoc注释的格式化：前导*号和HTML标签

（4）javadoc注释要仅靠在类、属性、方法之前

下面主要举例说明第三种注释的应用：

（1）首先编写.java文件

（2）在命令行中执行以下dos命令：

javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档

//javadoc标记：是@开头的，对javadoc而言，特殊的标记。

（3）在当前目录下就会产生doc文件夹，里面有一系列的.html文件

附上代码：

[java] view plain copy

span style="font-size:18px;"*/

/**javadoc注释的内容

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里面主要有三种注释：行注释、段落注释、文档注释

1)行注释：行注释也成为单行注释，行注释使用 “//注释文字”的格式来对某一行的代码进行注释或者加以说明

2)段注释：段注释也成为多行注释，通常是当说明文字比较长的时候的注释方法

3)文档注释：文档注释是Java里面的一个比较厉害的功能，它可以用于注释类、属性、方法等说明，而且通过JDK工具javadoc直接生成相关文档，文档注释的基本格式为“/**...*/”，不仅仅如此，文档注释本身还存在语法

什么是注释？如何在Java程序中加入注释？

试想一下，一个没有一句注释的程序源码，怎么读，一个程序要上万条代码不可能全部记得住哪一块是什么用，而且一个项目也不会是一个人独自完成，那样效率太低，多人合作就要给别人说明，每一块是什么用，方便他人使用，方便自己更正，而这些说明文字就是注释，注释不会被执行，不影响运行结果。

Java中代码的注释有三种：

// 注释一行

/* ...... */ 注释若干行

/** ...... */ 注释若干行，并写入 javadoc 文档

前两种比较容易理解，至于第三种，你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。