Java 注释说明

注释 
什么是注释呢？就是标注解释的意思，主要用来对Java代码进行说明。Java中有三种注释方式 （1）：// ：注释单行语句 
示例： 
//定义一个值为10的int变量 int a = 10; 
（2）：/*  */ ：多行注释 
示例： /* 
这是一个注释，不会被Java用来运行 这是第二行注释，可以有任意多行 */ 
（3）：/**  */ ：文档注释 
紧放在变量、方法或类的声明之前的文档注释, 表示该注释应该被放在自动生成的文档中(由javadoc命令生成的HTML文件)以当作对声明项的描述。 
示例： /** 
*  这是一个文档注释的测试 
*  它会通过javadoc生成标准的java接口文档 */ 
常常在javadoc注释中加入一个以“@”开头的标记，结合javadoc指令的参数，可以在生成的API文档中产生特定的标记

时间： 2024-10-13 06:53:52

Java 注释说明的相关文章

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

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

JAVA注释的另一种神奇用法

每个JAVA程序员在写程序的时候一定都会用到注释,本篇博客不是讲怎么定义注释,而是说明注释神奇的一种写法. 1 /** 2 * 这是一个测试类 3 */ 4 public class Test { 5 /** 6 * 程序的入口 7 */ 8 public static void main(String[] args) { 9 new Test(); 10 } 11 } 以上是两个普通的多行注释,在IDEA的环境下,选中方法或者类名,按住Ctrl+Q(Eclipse开发环境下直接按住Ctrl然后

java注释规范

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

Java注释用处

1.Java注释: 1 import cn.lonecloud.Doc; 2 3 /** 4 * Created by lonecloud on 2017/8/17. 5 * 测试注释类型 {@link Doc#test() 测试这个标签作用} 6 * @author lonecloud 7 * @see cn.lonecloud.Doc 8 * @version 1.0 9 * 10 */ 11 @Deprecated 12 public class JavaDocDemo { 13 /**

Java注释总结

Java注释总结 注释风格设置方法: WindowàpreferencesàJavaàCode StyleàCode TemplatesàComments javadoc注释 @author      类作者 @version     类版本 @see       转向参考 @param      方法参数说明 @return      方法返回值说明 @exception    方法异常说明     描述内容可以使用html标签 类中: 方法中: 注释快捷键 对类做注释在类的上一行打出"/**

Java注释分类

Java注释分类 1.单行注释    //打印结果    System.out.println("结果是:"+result); 2.多行注释    /**     * @author youhaidong     * for循环语句     */     for(int i=0;i<10;i++)     {         System.out.println(i);     } 3.文档注释    /**     * Description:     * @Author:yo

Java注释Annotation

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

myeclipse自定义java注释

myeclipse自定义java注释: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素 ----------------- 文件 (Files) 注释标签: /** * @Project : ${project_name} * @Title : ${file_name} * @Package ${package_name} * @Description : ${todo}

Java注释规范整理

在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个<Java的注释规范>,内容来自网络.书籍和自己的实际积累. JAVA注释规范 版本/状态 作者 版本日期 1.0 ghc 2008-07-02 一.背景 1.当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息? 2.怎么样避免我们的注释冗长而且凌乱不堪呢? 

Java 注释

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