JAVA注释方式--目前用的

代码整洁,规范,可读,注释是关键之一。

1.整个类文件注释

注释结构:
/*
 * @(#){类名称}.java       {创建时间}
 *
 * {某人或某公司具有完全的版权}
 * {使用者必须经过许可}
 */

2. 具体类功能注释

注释结构:

/**

* 类 <code>{类名称}</code>{此类功能描述}

*

* @author {作者}

* @version {版本,常用时间代替}

* @see     java.lang.Class

* @since   JDK{jdk版本}

*/

public class Object {}

3.     类变量注释

注释结构:

/** {此值是用来存储/记录什么的}*/

private String str ;

4.     类方法注释

注释结构:

/**

* {方法的功能/动作描述}

*

* @param      {引入参数名}   {引入参数说明}

* @return      {返回参数名}   {返回参数说明}

* @exception  {说明在某情况下,将发生什么异常}

*/

public String substring(int beginIndex) {

return substring(beginIndex, count);

}

5.     类方法中代码块注释

注释结构:

/*

* {功能描述}

*

* {具体实现动作}

*/

时间: 2024-10-10 05:59:12

JAVA注释方式--目前用的的相关文章

JAVA注释方式

1.单行(single-line)注释    //-- 2.块(block)注释                /*--*/ 3.文档注释                      /**--*/

Java注释

注释(commentary )是程序中用于说明和解释的一段文字对程序运行不起作用.程序 中添加注释的目的是增强程序的可读性. Java提供3种注释方式:. 单行注释:// 多行注释/**/ 文档注释: /** *文档注释用于从源代码自动生成文档执行javadoc *命名根据源代码中的内容生成网页 *@XXX <-- 可以加入javadoc参数产生相应的文档 */ 不同格式的注释可以嵌套. // Welcome1.java. Text-printing program. /*计信学院09软件工程2

htm,css,javascript及其他的注释方式

转自:http://www.cnblogs.com/dapeng111/archive/2012/12/23/2829774.html 一.HTML的注释方法<!-- html注释:START -->内容<!-- html注释:END --> 包含在“<!--”与“-->”之间的内容将会被浏览器忽略,且不会显示在用户浏览的最终界面中. 注释的部分虽然浏览器在执行时会忽略,但在浏览器中查看源代码时仍然可以看到 二.CSS的注释方法<style type="

java注释规范

前言: 现在java的出产地sun公司并没有定义一个java注释规范,注释规范目前是每个公司自己有自己的一套规范,主要是为了团队之间的协作. 1.基本规则 1.注释应该使代码更加清晰易懂 2.注释要简洁明了,只要提供能够明确理解程序必要的信息就可以了.如果注释太复杂会影响程序整洁度和阅读感. 3.注释不仅描述程序作了什么,还要描述为什么这样做以及约束. 4.对于一般的getter和setter方法不用注释. 5.类.接口.构造函数.方法.全局变量必须添加注释.字段属性可以选择添加简单注释. 6.

Java注释Annotation

 Java注释Annotation 从JDK 5开始,Java增加了对元数据(MetaData)的支持,也就是Annotation(注释).Annotation提供了一种为程序元素设置元数据的方法,程序元素包括修饰包.类.构造器.方法.成员变量.参数.局部变量,从某些方面来看,Annotation就想修饰符一样,可用于程序元素的声明,这些信息被存储在Annotation的"name = value"对中. 需要注意的是, Annotation是一个接口,程序可以通过反射来获取指定程

Java 注释说明

注释 什么是注释呢?就是标注解释的意思,主要用来对Java代码进行说明.Java中有三种注释方式 (1):// :注释单行语句 示例: //定义一个值为10的int变量 int a = 10; (2):/*  */ :多行注释 示例: /* 这是一个注释,不会被Java用来运行 这是第二行注释,可以有任意多行 */ (3):/**  */ :文档注释 紧放在变量.方法或类的声明之前的文档注释, 表示该注释应该被放在自动生成的文档中(由javadoc命令生成的HTML文件)以当作对声明项的描述. 

Java 注释

Java 注释 标签 : Java基础 五月份得知入职阿里云OS, 才开始学Java, 断断续续学习/使用半年, 越来越喜欢这个语言/工具. 后来被拥抱变化之后, 拿到的大部分offer是Java服务端研发; 一路走来, 踩了很多坑, 也有了一点小小的心得, 而且博客已经停更几个月, 今天就以博客形式把他记录下来吧. 2015下半年第一篇博客, 从最基础的Java注释开始: 程序员圈有一个笑话 最讨厌在写代码的时候写注释, 最讨厌别人的代码里面不写注释. 为什么写注释? 我自己亲身经历: 这段时

java注释、关键字与标识符

通常我们需要在源代码中添加文字用来对进行代码解释说明,但这些文字并不是Java代码的语法,会导致编译出错.这时我们可以使用注释来完成这一事项! 在编译时,编译器会忽略注释的存在,就好像注释内容不存在一样.所以注释并不会导致编译出错,同时注释还方便编写者和其他人阅读源代码,加强对代码的理解. Java中提供了三种注释方式,分别是: 1 单行注释 //注释内容 2 多行注释 /*注释内容*/ 3 文档注释 /**注释内容*/ 其中文档注释与多行注释作用基本相同,唯一的区别是文档注释可以使用javad

java注释 命名 数据类型 基本类型转换 位运算符 逻辑运算符 三目运算符

一.java注释 1.单行注释  //注释内容 2.多行注释 /*注释内容*/ 3.文档注释(可用javadoc工具生成api文档,不过我还没试过)/**文档注释*/,文档注释可以在使用的时候看见注释. 文档注释常用的标记 @auther作者 @version版本 @deprecated 不推荐使用 @param 本放的参数 @return 返回值 @throws异常,同@exception 二.java的命名 1.项目名 字母全部小写 2.包名 全部小写 3.类名 首字母大写加驼峰 4.方法名