java程序注释怎么写

java的块注释怎么写

1.java 中的几种注释方式

我看动力节点的java基础大全301集教中的三种注释方法:1、单行注释 //注释的内容2、多行注释 /*。

*/3、/**。

*/,这种方式和第二种方式相似。

这种格式是为了便于javadoc程序自动生成文档。下面介绍一下Javadoc的标记:特别声明: (1)javadoc针对类生成注释文档 (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*/ /**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()!"); } } [java] view plain copyimport java.io.IOException; /**javadoc注释内容 *@since 1.0 *@version 1.1 *@author Blue Jey *链接到另一个文档{@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"; } } 注意:如果源文件中有用到@version,@author标记,则在执行javadoc命令时,要加-version -author javadoc -version -author -d doc *.java (其中用-version用于提取源文件中的版本信息 -author用于提取源文件中的作者信息)。

2.如何写Java文档注释

1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。

如果单行无法完成,则应采用块注释。 注释格式:/* 注释内容 */ 行头注释:在代码行的开头进行注释。

主要为了使该行代码失去意义。 注释格式:// 注释内容 行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。

一般与代码行后空8(至少4)个格,所有注释必须对齐。 注释格式:代码 + 8(至少4)个空格 + // 注释内容 2、块(block)--块注释:/*……*/ 注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。

一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。

注释格式通常写成: /* * 注释内容 */ 3、文档注释:/**……*/ 注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符 /**。

*/ 。

3.java元注解,局部注解怎么解析

对于局部变量的注解只能在源码级别上进行处理,类文件并不描述局部变量。因此,所有的局部变量注解在编译完一个类的时候就会被遗弃掉。同样地,对包的注解不能在源码级别之外存在。

在文件package-info.java中注解一个包,该文件只包含以注解先导的包声明

包注解需要在特定文件:package-info.java,中添加,获取如下:

Package pkg = TestAnnotation.class.getPackage();

boolean hasAnnotation=pkg.isAnnotationPresent(Xpc.class);

if (hasAnnotation){

Xpc xpc=pkg.getAnnotation(Xpc.class);

System.out.println("package:" + pkg.getName());

System.out.println("id=" + xpc.id());

System.out.println("name=" + xpc.name());

System.out.println("gid=" + xpc.gid());

}

4.如何写Java文档注释

如何写Java文档注释(Java Doc Comments)

本文翻译自How to Write Doc Comments for the Javadoc Tool,但是精简了一些私以为不重要的东西

本文不讨论如何使用javadoc工具自动生成文档的方法,而是主要探讨应该如何去写文档注释

业余时间整理,难免有遗漏或错误,如有发现欢迎指正

转载地址:网页链接

文档注释概览

“文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释,它是一种带有特殊功能的注释。

文档注释与一般注释的最大区别在于起始符号是/**而不是/*或//。

比如:

/**这是文档注释*/

/* 这是一般注释*/

// 这是一般注释

在一些IDE(比如Eclipse)中,文档注释会以不同于普通注释的颜色高亮显示。

此外,文档注释只负责描述类(class)、接口(interface)、方法(method)、构造器(constructor)、成员字段(field)。相应地,文档注释必须写在类、接口、方法、构造器、成员字段前面,而写在其他位置,比如函数内部,是无效的文档注释。

文档注释采用HTML语法规则书写,支持HTML标记(tag),同时也有一些额外的辅助标记。需要注意的是,这些标记不是给人看的(通常他们的可读性也不好),他们的作用是为了javadoc工具更好地生成最终文档。所以,虽然有些标记写起来麻烦且看着不直观,还是要老老实实按规矩写滴。

原文地址:网页链接

5.java语言注释怎么写,谁帮我写一下我的代码注释

/**

* 类

* @author xx

*

*/

public class Hll {

/**

* main方法

* @param args

*/

public static void main(String[] args) {

// new一个新对象

Man m = new Man();

m.name = "张三";

m.gender = "男";

m.study(m.name);

}

}

/**

* 接口

* @author xx

*

*/

interface Person {

public int a = 20;

public void study(String s);

}

/**

* 实现Person接口

* @author xx

*

*/

class Man implements Person {

String name;

String gender;

public void study(String s) {

this.name = s;

System.out.print(this.name + "在学习中" + this.gender + "哪里");

}

}

6.Java菜鸟求教,请帮忙把每一语句块注释下,作用、目的是什么,谢谢

public class B {

public static void main(String[] args) {

//定义对象m为ArrayList类型,长度为100

ArrayList m = new ArrayList(100);

//循环赋值,第1个元素为1,第2个元素为2。,第100个元素为100

for (int i = 0; i 2) {

//将sy()方法返回的对象赋值给m

m = sy(m, m.size());

}

//获得第2个元素赋给n

n = m.get(1);

//输出

System.out.print(n);

}

public static ArrayList sy(List s, int num) {

//定义对象list为ArrayList类型

ArrayList list = new ArrayList();

//如果num除以3的余数不等于0

if (num % 3 != 0) {

//循环的次数为num除以3的余数

for (int i = num % 3; i > 0; i--) {

//获得s中位置为num-i的元素,添加到list中

list.add(s.get(num - i));

//输出list

System.out.println(list);

}

}

//循环,条件为i小于num减去num除以3的余数

for (int i = 1; i 1) {

for (int i = 0; i

java的块注释怎么写

转载请注明出处育才学习网 » java程序注释怎么写

知识

罗梅芬用日文怎么写(罗钰潇日语怎么写)

阅读(21430)

本文主要为您介绍罗梅芬用日文怎么写,内容包括伊蕾娜日语怎么写,王雪菲用日文怎么说,张佳怡在日语中怎么写啊怎么读啊。罗 ら ラ ra钰 ぎょく ギョク gyoku潇 しょう シヨウ shou第一列:日语汉字,写法同汉字,都要用繁体,这三个都挺难写的,看

知识

邓先生的英文怎么写(1~40的英文怎么说)

阅读(10448)

本文主要为您介绍邓先生的英文怎么写,内容包括“邓先生”用英语怎么写,1~40的英文怎么说,漂亮英文beautiful缩写怎么写。1 one 2 two 3 three 4 four 5 five 6 six 7 seven 8 eight 8 nine 10 te

知识

一个人布满皱纹怎么写(描写人物皱纹的句子)

阅读(9523)

本文主要为您介绍一个人布满皱纹怎么写,内容包括描写人物皱纹的句子,描写人物皱纹的句子,皱纹怎么描写。、老人脸上布满了皱纹,那一条条曲折不均的像是墙上斑驳的印迹,爬满了面容,留下了岁月的痕迹。2、外祖父是一位年过六旬的白发老人。在他

知识

登录接口怎么写(php登录的接口怎么写)

阅读(7768)

本文主要为您介绍登录接口怎么写,内容包括php登录的接口怎么写,网页登陆接口怎么做,网站登录接口程序怎么做。PHP 接口 接口 使用接口(interface),你可以指定某个类必须实现哪些方法,但不需要定义这些方法的具体内容。我们可以通过int

知识

档案奖惩情况怎么写(奖惩情况怎么写)

阅读(9606)

本文主要为您介绍档案奖惩情况怎么写,内容包括奖惩情况怎么写,个人简历及奖惩情况怎么填写,个人简历里面奖惩情况怎么写。在简历里的“奖励”部分,列出与你所获得的并与你的求职目标相关的荣誉、奖励和奖金。你既可以按时间顺序排列,也可以按

知识

头孢克肟拼音怎么写(头孢克肟的肟念什么)

阅读(8008)

本文主要为您介绍头孢克肟拼音怎么写,内容包括头孢克肟片全名拼音,头孢克肟片全名拼音,头孢克肟的肟念什么。肟[wò] :是含有羰基的醛、酮类化合物与羟胺作用而生成的有机化合物,可以参与许多有机化学反应,例如经典的Beckmann重排就是肟为底

知识

一库搜用日语怎么写(日语一库是什么意思)

阅读(7998)

本文主要为您介绍一库搜用日语怎么写,内容包括日语大神来,看动漫里的主人公说一句:恰,一库搜这是什么意思,一库一库;一搜库这两个日语是什么意思怎么写,看片都有“一库”(日语)是什么意。一库的意思就是“出发,出去”的意思。日语「行く」的音译

知识

外租无人机广告怎么写(植保无人机广告语)

阅读(7005)

本文主要为您介绍外租无人机广告怎么写,内容包括求一个无人机创意广告词谢谢巨友们了,求一关于无人机的广告标语,求一关于无人机的广告标语我们公司是做无人机的,新成立的公司,求。DJI大疆创新研发的的MG-1农业植保机专为农村作业环境设计,

知识

河南话que怎么写(河南话的nenna怎么写)

阅读(6538)

本文主要为您介绍河南话que怎么写,内容包括que怎么写,河南话的nenna怎么写,que怎么写。尿一壶(niào yī hú)关系密切,观点一致。例:“他俩今天尿一壶啦。”●尿(niào)⑴、从尿道排泄的液体。⑵、排泄小便。⑶、不放

知识

国学经文的论文怎么写(国学征文该怎么写)

阅读(7120)

本文主要为您介绍国学经文的论文怎么写,内容包括国学征文该怎么写,弟子规的400论文,关于国学经典的征文怎么写。“子曰:“温故而知新,可以为师”……小时,总是觉得国学就是没用的,古人写的话,我们还需要背,每次老师教给我们时,我总是会让思想开一

知识

化学实验总结怎么写(化学实验报告小结怎么写)

阅读(5399)

本文主要为您介绍化学实验总结怎么写,内容包括化学实验总结怎么写,化学实验报告小结怎么写,化学实验小结怎么写。化学实验报告的书写: 一般情况下化学实验报告是根据实验步骤和顺序从七方面展开来写的: 1.实验目的:即本次实验所要达到的目标或

知识

蝴蝶豌豆拼音怎么写(豌豆的拼音是什么)

阅读(5833)

本文主要为您介绍蝴蝶豌豆拼音怎么写,内容包括蝴蝶怎么拼音的,豌豆的拼音是什么,蝴蝶的拼音是什么。豌豆的拼音是[wān dòu]。豌豆是豆科一年生攀援草本,高0.5-2米。全株绿色,光滑无毛,被粉霜。叶具小叶4-6片,托叶心形,下缘具

知识

海绵宝宝用英文怎么说(海绵宝宝用英文怎么说)

阅读(6515)

本文主要为您介绍海绵宝宝用英文怎么说,内容包括海绵宝宝用英语怎么说,海绵宝宝用英文怎么说,海绵宝宝英文名是什么。1. SPONGEBOB SQUAREPANTS 近期很夯的一步卡通影片《海绵宝宝》(SpongeBob SquarePants)是一系

知识

茶盏怎么用(茶盏在茶道中干嘛用)

阅读(5426)

本文主要为您介绍茶盏怎么用,内容包括茶盏怎么用我要写一篇200字左右的茶盏的使用说明,求指教,茶盏在茶道中干嘛用,问一下斗笠盏如何使用现在是不是很少有人使用它,它的意义。苏东坡的名句"从来佳茗似佳人",典型地代表了唐宋及以后的文人墨客,

知识

thinkpad小红点怎么用(怎么学习使用thinkpad小红点)

阅读(7589)

本文主要为您介绍thinkpad小红点怎么用,内容包括怎么学习使用thinkpad小红点,thinkpad小红点怎么用,求教:THINKPAD的小红点使用方法。Thinkpad 小红点最高效的使用方法为:左手拇指按左键,无操作时在左键待命2、右手拇指按右键,同时兼按空格键及