JAVA代码注释范例
package ng;
注释结构:
/* * @(#){类名称}.java {创建时间} * * {某人或某公司具有完全的版权} * {使用者必须经过许可} */
package ng;
2. 具体类功能注释 示例如下:
/** * Class <code>Object</code> is the root of the class hierarchy. * Every class has <code>Object</code> as a superclass. All objects, * including arrays, implement the methods of this class. * * @author unascribed * @version 1.61, 01/23/03 * @see ng.Class * @since JDK1.0 */ public class Object {}
ifSucc = StressTestDataDao.addStressTestData(db,stressTestDataBean); }else{
ifSucc = StressTestDataDao.mendStressTestData(db,stressTestDataBean); }
注释结构:
}
注释结构:
/** * {方法的功能/动作描述} * * @param {引入参数名} {引入参数说明} * @return {返回参数名} {返回参数说明} * @exception {说明在某情况下,将发生什么异常} */ public String substring(int beginIndex) {
ifSucc = StressTestDataDao.addStressTestData(db,stressTestDataBean); }else{
ifSucc = StressTestDataDao.mendStressTestData(db,stressTestDataBean); }
<code>beginIndex</code> is negative or larger than the
*
length of this <code>String</code> object.
*/
public String substring(int beginIndex) {
return substring(beginIndex, count);
JAVA 代码注释范例 作者: 周建东 日期: 2007-10-18 03:31
字体大小: 小 中 大
整个类文件注释
示例如下:
/* * @(#)Object.java 1.61 03/01/23 * * Copyright 2003 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */
* </pre></blockquote>
*
* @param beginIndex the beginning index, inclusive.
* @return the specified substring.
* @exception IndexOutOfBoundsException if
*
/*
* {功能描述} * * {具体实现动作} */ boolean ifSucc = false; if(request.getParameter("YINGLI_ID")==null){
String GUID = new RandomGUID().toString(); stressTestDataBean.setUSER_ID(Integer.toString(userId)); stressTestDataBean.setSIGN_ISBN((String)vSectNum.get(0)); stressTestDataBean.setSHENHE_JIEGUO("0"); stressTestDataBean.setGUID(GUID); stressTestDataBean.setCREATE_DATE("getdate()"); stressTestDataBean.setSTATE("A");
return substring(beginIndex, count); }
5. 类方法中代码块注释 示例如下:
/* * 调用持久化类，将数据保存到库 * * 判断是添加，还是修改 */ boolean ifSucc = false; if(request.getParameter("YINGLI_ID")==null){
/** The value is used for character storage. */ private char value[];
注释结构:
/** {此值是用来存储/记录什么的}*/ Hale Waihona Puke rivate String str ;
4. 类方法注释 示例如下:
/** * Returns a new string that is a substring of this string. The * substring begins with the character at the specified index and * extends to the end of this string. <p> * Examples: * <blockquote><pre> * "unhappy".substring(2) returns "happy" * "Harbison".substring(3) returns "bison" * "emptiness".substring(9) returns "" (an empty string)
注释结构:
/** * 类 <code>{类名称}</code>{此类功能描述} * * @author {作者} * @version {版本,常用时间代替} * @see ng.Class * @since JDK{jdk 版本}
*/ public class Object {}
3. 类变量注释 示例如下:
String GUID = new RandomGUID().toString(); stressTestDataBean.setUSER_ID(Integer.toString(userId)); stressTestDataBean.setSIGN_ISBN((String)vSectNum.get(0)); stressTestDataBean.setSHENHE_JIEGUO("0"); stressTestDataBean.setGUID(GUID); stressTestDataBean.setCREATE_DATE("getdate()"); stressTestDataBean.setSTATE("A");
java 注解引用注解
java 注解引用注解在Java中，注解可以引用其他注解。
这种情况通常发生在自定义注解中，当我们想要在一个自定义注解中使用另一个已经存在的注解时，就需要引用注解。
要在一个注解中引用另一个注解，可以使用`@`符号后跟被引用注解的名称。
这样就可以将被引用的注解的功能嵌入到当前的注解中，从而实现更加灵活和复杂的功能。
举个例子，假设我们有一个自定义注解`@Author`用来标记作者信息，同时我们想要在这个注解中引用`@Deprecated`注解来表示该作者信息已经过时，我们可以这样做：java.@Deprecated.public @interface Author {。
String name();String date();}。
在这个例子中，我们在`@Author`注解前使用了`@Deprecated`注解，这样所有使用`@Author`注解的地方也会被标记为过时的。
另外，需要注意的是，被引用的注解可以拥有自己的属性，这些属性可以在引用的时候进行赋值。
例如：java.public @interface Author {。
String name();String date();Deprecated deprecation() default @Deprecated;}。
在这个例子中，我们在`@Author`注解中引用了`@Deprecated`注解，并为`deprecation`属性设置了默认值为`@Deprecated`注解。
总的来说，Java中的注解引用注解可以帮助我们实现更加灵活和复杂的功能，使得我们的代码可以更好地表达和描述。
通过合理地使用注解引用注解，我们可以提高代码的可读性和可维护性。
Java中的注解（Annotation）
Java中的注解（Annotation）⽬录结构：contents structure [+]1.2.3.1.2.4.1.2.1.什么是注解⽤⼀个词就可以描述注解，那就是元数据，即⼀种描述数据的数据。
所以，可以说注解就是源代码的元数据。
⽐如，下⾯这段代码：@Overridepublic String toString() {return "This is String Representation of current object.";}上⾯的代码中，我重写了toString()⽅法并使⽤了@Override注解。
但是，即使我不使⽤@Override注解标记代码，程序也能够正常执⾏。
那么，该注解表⽰什么？这么写有什么好处吗？事实上，@Override告诉编译器这个⽅法是⼀个重写⽅法(描述⽅法的元数据)，如果⽗类中不存在该⽅法，编译器便会报错，提⽰该⽅法没有重写⽗类中的⽅法。
如果我不⼩⼼拼写错误，例如将toString()写成了toStrring(){double r}，⽽且我也没有使⽤@Override注解，那程序依然能编译运⾏。
但运⾏结果会和我期望的⼤不相同。
现在我们了解了什么是注解，并且使⽤注解有助于阅读程序。
Annotation是⼀种应⽤于类、⽅法、参数、变量、构造器及包声明中的特殊修饰符。
它是⼀种由JSR-175标准选择⽤来描述元数据的⼀种⼯具。
2.为什么要使⽤注解使⽤Annotation之前(甚⾄在使⽤之后)，XML被⼴泛的应⽤于描述元数据。
不知何时开始⼀些应⽤开发⼈员和架构师发现XML的维护越来越糟糕了。
他们希望使⽤⼀些和代码紧耦合的东西，⽽不是像XML那样和代码是松耦合的(在某些情况下甚⾄是完全分离的)代码描述。
假如你想为应⽤设置很多的常量或参数，这种情况下，XML是⼀个很好的选择，因为它不会同特定的代码相连。
如果你想把某个⽅法声明为服务，那么使⽤Annotation会更好⼀些，因为这种情况下需要注解和⽅法紧密耦合起来，开发⼈员也必须认识到这点。
java 链式写法注解
Java 链式写法通常是通过在方法返回值上调用另一个方法来实现的。
这种写法可以让代码更加简洁、易读和易于维护。
下面是一个使用注解的Java 链式写法的示例：```javapublic class Person {private String name;private int age;private String address;@Overridepublic String toString() {return "Person{" +"name='" + name + '\'' +", age=" + age +", address='" + address + '\'' +'}';}public Person setName(String name) { = name;return this;}public Person setAge(int age) {this.age = age;return this;}public Person setAddress(String address) {this.address = address;return this;}}```在上面的代码中，我们定义了一个Person 类，并使用了链式写法的set 方法来设置属性值。
在每个set 方法中，我们返回当前对象的实例，以便可以在同一个对象上进行多个设置。
同时，我们还使用了注解@Override 来覆盖了toString 方法，以便在打印对象时能够以更友好的方式显示属性值。
程序基本概念
1、课程名称：程序基本概念2、知识点2.1、上次课程的主要知识点CLASSPA TH使用2.2、本次预计讲解的知识点1、注释的使用；2、Java的关键字。
3、具体内容（★★★★★）3.1、注释很多时候需要针对于程序做一些说明，尤其是大型的开发项目之中。
理论上注释是为了方便开发者自己进行维护所准备的，并且应该越详细越好，但是事实上很多开发者懒得写注释。
如果日后你们作为项目管理人员，注释直接决定你的项目成败。
在Java中对于注释一共分为三种：·单行注释：//；·多行注释：/* .... */；·文档注释：/** ... */注释一旦出现，程序将不会对其进行任何的处理。
范例：使用注释3.2、关键字与标识符在程序中描述类名称、方法名称、变量等概念就需要使用到标识符来定义。
而在Java中标识符的定义原则如下：由字母、数字、_、$所组成，其中不能够以数字开头，不能够使用Java的保留字（关键字）。
对于以上的定义格式有如下的解释：·以后你自己写的代码都建议使用字母表示，例如：name、student_name、sname123；·系统生成代码，可以在开头使用“_”（现在跟你们没关系）；·“$”虽然作为标识符组成，但是与你们的编写代码无关，有其自己特殊的使用环境。
实际中定义可以计划：由字母、数字、_所组成，必须以字母开头。
关键字是不能够作为标识符的，关键字又被称为保留字。
关键字有自己特殊的含义，所以不能过作为标记使用。
但是对于给出的关键字有几点说明：·Java有两个未使用到的关键字：goto（无条件跳转）、const（常量）；·严格来讲“true”、“false”、“null”不是关键字，而是具备特殊含义的标记；·JDK 1.4增加了assert关键字，用于断言操作；·JDK 1.5增加了enum关键字，用于枚举操作。
java 自定义注解 传参
java 自定义注解传参一、概述注解是 Java 编程中一个非常有用的特性，它允许开发者向代码添加元数据，而无需修改源代码。
自定义注解是开发者根据需求自定义的注解，可以用于标记代码中的特定部分，并在程序运行时进行各种处理。
在 Java 中，可以通过在代码中添加自定义注解并传递参数来扩展注解的功能。
二、注解定义要创建自定义注解，需要使用 Java 注解（@interface）在代码中定义一个或多个标记（annotation）。
标记可以包含属性（attribute），这些属性定义了注解的含义和行为。
例如，下面的代码定义了一个名为 CustomAnnotation 的自定义注解，该注解带有两个属性：name 和 value。
```java@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)public @interface CustomAnnotation {String name();String value();}```三、注解使用定义了自定义注解后，可以在代码中使用它来标记特定的元素。
使用自定义注解时，可以传递参数。
例如，下面的代码演示了如何使用上述定义的 CustomAnnotation 注解并传递参数：```java@CustomAnnotation(name = "MyCustomAnnotation", value = "This is a custom annotation")public void myMethod() {// 方法体}```四、注解处理器注解处理器是在程序运行时处理注解的组件。
当编译器编译代码时，它会将注解附加到被标记的方法上。
要执行运行时的注解处理，需要编写一个 Java 类来处理这些注解，并将其注册为注解处理器。
这可以通过实现一个接口来完成，该接口由 Java 自带的`javax.annotation.processing` 包提供。
java中代码的注释和快捷键
java中代码的注释和快捷键添加必要的注释，对一个有责任心、有道德模范的前端必须具备的好习惯，可以大大提高代码的可维护性、可读性。
java代码注释快捷键：ctrl+shift+/首先熟悉一下html、css、js的注释的写法：1、HTML注释语法：<!--注释的内容-->2、css注释语法/* 注释内容*//* ----------文字样式开始---------- */3、javaScript注释//注释内容/*注释内容*/接下来是对注释在这几种代码中使用的位置，如何写注释进行总结一下。
（根据个人的习惯可能不一样）1、html注释使用的位置：1）一般会使用在一些主要节点标签结束的后边，如：<div class="wrap"><div class="main">...</div><!--main end--> <div><!--wrap end-->2）使用在一些循环的结束的后边，如：<ul class="list"><li>111111</li><li>222222</li><li>333333</li> </ul><!--list loop-->2、css注释一般会使用在定义某个模块样式的上边，说明这段样式是作用于哪段模块，如：/*通用- 评论*/.comment{...}/*相册*/.photo{...}/*分享*/.share{...}/*投票*/.vote{...}3、javascript注释一般将注释添加在某段功能函数的上边，说明函数的功能、作者、作者信息、修改时间。
//================================================= =======// 截断字符// steepvi// rtx:*******// 2010-10-14//================================================= =======最后，注释也是字符也是会有流量产生。
idea java 多行注释
一、概述在Java编程语言中，注释是一种非常重要的语法元素，用于向程序的读者解释代码的作用，或者是临时屏蔽某些代码片段。
Java中有单行注释和多行注释两种方式，本文将重点介绍多行注释的使用方法和相关注意事项。
二、多行注释的格式多行注释是指可以跨越多行的注释形式，在Java中使用/*和*/包括起来的内容即为多行注释。
其格式如下：/*这是一段多行注释可以跨越多行*/三、多行注释的使用场景多行注释主要用于以下几种情况：1. 对代码进行较为详细的注释说明，方便程序的阅读与理解。
2. 临时屏蔽一段代码，调试程序或查找错误时使用，相比于单行注释更加便利。
3. 用于生成文档，许多Java文档生成工具可以自动提取多行注释的内容，生成类、方法等的说明文档。
四、多行注释的注意事项在使用多行注释时，需要注意以下几点：1. 多行注释不能嵌套，即/* */之间不能再包含/* */形式的注释内容。
这可能导致编译错误。
2. 多行注释不能出现在字符串常量中，否则编译器也会发出错误提示。
3. 多行注释不能出现在代码中的任何位置，只能以注释的形式独立存在，不能与代码混合在一起。
五、多行注释的最佳实践在实际的Java编程中，应该遵循以下几点关于多行注释的最佳实践：1. 注释要简洁明了，不要写过多无用的注释，遵循“必要的注释”原则。
2. 注释内容应该符合代码的逻辑结构，能够清晰地表达代码的意图。
3. 对于一些复杂算法或者特殊处理逻辑，应当使用多行注释进行详细说明，方便后续的维护和理解。
六、多行注释的案例下面是一个使用多行注释的实际案例，展示了多行注释在Java中的使用方法：/*这是一个计算斐波那契数列的方法参数n代表数列的长度返回一个长度为n的斐波那契数列数组*/public int[] fibonacci(int n) {int[] result = new int[n];result[0] = 0;result[1] = 1;for (int i = 2; i < n; i++) {result[i] = result[i - 1] + result[i - 2];}return result;}七、总结多行注释在Java中是一种非常重要的语法元素，能够帮助开发者、维护者更好地理解和阅读代码。
java习题及答案第3章 习题参考答案
第3章习题解答1. Java语言的注释有哪几种？分别给出一个例子。
答：Java语言的注释有3种，分别是单行注释、多行注释和文档注释。
单行注释的例子如下：public static Point origin = new Point(0, 0); //类初始化时，创建一个原点实例多行注释的例子如下：/* 类初始化时，创建一个原点实例 */public static Point origin = new Point(0, 0);文档注释的例子如下：/**** @类名：Point* @类简介：坐标点类，可以初始化其坐标x和y。
* @编程人：林福平* @编程日期：2012-8-9* @修改日期：2012-8-10**/2. Java语言中分隔符有哪几种？空白符有哪些？答：Java语言中的分隔符有空白符、注释和普通分隔符三种。
Java语言中的空白符（White Space）包括空格（SP，space）、制表符(‘\t’，Tab键)、走纸换页(‘\f’)、回车(‘\r’)和换行(‘\n’)。
3. 简述标识符的用途。
下列字符串中，哪些是标识符？PIx2 -length a+b _bytes $long MIN_VALUE答：Java语言中的标识符用于对类、方法、变量、类型、数组和文件等进行命名。
上述字符串中，以下这些是Java语言的标识符：PIx2 _bytes $long MIN_VALUE4. 下列字符串中，哪些是关键字？true for int null $float _double答：上述字符串中，以下这些是Java语言的关键字：true for int null5. Java语言的基本数据类型分为那几大类？答：Java语言的基本数据类型分为数值类型（包括整数类型和浮点类型）、字符类型(char)和布尔类型(Boolean)。
整数类型有byte、 short、 int和long。
浮点类型有float和double。
注释文范文
注释文范文注释文是指在程序代码中添加的注释，用于解释代码的作用、实现方法、变量含义等信息。
良好的注释文可以提高代码的可读性和可维护性，降低代码出错的概率。
本文将介绍注释文的写法和范例。
注释文的写法单行注释单行注释是指在一行代码后面添加注释，用于解释该行代码的作用。
单行注释以//开头，直到该行结束为止。
例如：int a =1;// 定义一个整型变量a，初始值为1多行注释多行注释是指在多行代码中间添加注释，用于解释一段代码的作用。
多行注释以/*开头，以*/结尾。
例如：/** 定义一个Person类，包含姓名和年龄两个属性*/public class Person {private String name;// 姓名private int age;// 年龄}文档注释文档注释是指在类、方法、变量等定义前添加注释，用于生成API文档。
文档注释以/**开头，以*/结尾。
文档注释可以包含多行注释和特殊标记，例如：/***计算两个数的和* @param a 第一个数*@param b 第二个数*@return 两个数的和*/public int add(int a,int b){return a + b;}注释文的范例Java以下是一个Java程序的注释文范例：/***计算阶乘* @param n 阶乘的值*@return 阶乘的结果*/public static int factorial(int n){if(n ==0){// 如果n为0，返回1return1;}else{// 否则，递归计算n-1的阶乘并乘以n return n *factorial(n -1);}}Python以下是一个Python程序的注释文范例：def factorial(n):"""计算阶乘:param n: 阶乘的值:return: 阶乘的结果"""if n ==0: # 如果n为0，返回1return1else: # 否则，递归计算n-1的阶乘并乘以nreturn n * factorial(n -1) JavaScript以下是一个JavaScript程序的注释文范例：/*** 计算阶乘* @param{number} n 阶乘的值* @returns {number} 阶乘的结果*/function factorial(n) {if (n ==0) { // 如果n为0，返回1return1;} else { // 否则，递归计算n-1的阶乘并乘以n return n *factorial(n -1);}}总结注释文是程序代码中必不可少的一部分，良好的注释文可以提高代码的可读性和可维护性，降低代码出错的概率。
(完整word版)JAVA代码规范详细版
JAVA代码规范本Java代码规范以SUN的标准Java代码规范为基础，为适应我们公司的实际需要，可能会做一些修改。
本文档中没有说明的地方，请参看SUN Java标准代码规范。
如果两边有冲突，以SUN Java标准为准。
1. 标识符命名规范1.1 概述标识符的命名力求做到统一、达意和简洁。
1.1.1 统一统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。
统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。
即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。
1.1.2 达意达意是指，标识符能准确的表达出它所代表的意义，比如：newSupplier, OrderPaymentGatewayService等；而supplier1, service2，idtts等则不是好的命名方式。
准确有两成含义，一是正确，而是丰富。
如果给一个代表供应商的变量起名是order，显然没有正确表达。
同样的，supplier1, 远没有targetSupplier意义丰富。
1.1.3 简洁简洁是指，在统一和达意的前提下，用尽量少的标识符。
如果不能达意，宁愿不要简洁。
比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长，transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。
省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。
1.1.4 骆驼法则Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。
比如: supplierName, addNewContract，而不是supplier_name, add_new_contract。