锐客网

  1. 首页 > 睿知 > it技术 > >

java代码注释方法 java代码如何注释

IT技术代码

java 中的几种注释方式三种类型：
1、单选注释：符号是：//
2、块注释： 符号是： /**/ 可以跨多行
3、javadoc注释： 符号是： /***/ 可以跨多行 ， 
生成javadoc时，这样的注释会被生成标准的javaapi注释 。
java 语句如何注释单行注释//快捷键Ctrl+/
//M4_4aaForm fr = (M4_4aaForm) form;
多行注释/*
*
*/
生成帮助文档的注释
/**
* Function: Action実行br
*
* Produce Describe:
*
* @param mapping
* @param form
* @param request
* @param response
* @return
* @throws SysException
* @throws DBException
*/
为什么要为程序添加注释，在java程序中如何为程序添加注释？注释是用来给开发者或者是软件后续的维护者来看的 。一般是用来描述这一段代码或者是程序做了些什么样的事情 。实现了哪些功能 ， java里面注释代码，可以分为行注释和块注释 ， 方法注释等 。
行注释就是在需要注释的代码前加 //
块注释则是用 /*和*/把文本段落框起来即可
如何写好java代码注释写代码的时候java代码注释方法，有时候 ， java代码注释方法你需要写一些注释，把内容相互关联起来，方便自己或别人看的时候，可以直接找到java代码注释方法你关联的代码类或者啥的 。
这个时候，{@link}与@see ， 这2个javadoc注解就派上用场java代码注释方法了，
不管他具体有什么功能，咱就只管一个，他可以链接代码，让注释看的更清楚易懂 。方便你我他 。
@see 标签允许用户引用其他类的文档 。具体使用方式如下：
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称
我在使用的时候 ， 发现这个只能单独一行顶头写 ， 如果不顶头写就不管用了 ， 没了链接的效果 。
但是 ， {@link}这个却可以随便放 。
具体使用方法和上面那个@see是一样的 。
实际效果 ， 看下面的图
Java代码注释ResourceBundle res;
//打开对应java代码注释方法的db.prop属性文件文件java代码注释方法 ， 和java代码注释方法你的java class同一目录下
res = ResourceBundle.getBundle("db");
//从文件中取得ulr, user, password, jdbc driver名字
String url=res.getString("url");
String user=res.getString("user");
String password=res.getString("password");
String className = res.getString("classname");
try{
//初始化java代码注释方法你的jdbc dirver
Class.forName(className).newInstance();
//建立connection
conn = DriverManager.getConnection(url,user,password);
}catch(Exception e)
{
e.printStackTrace();
}
return conn;
如何在java程序中添加注释1、单行(single-line)--短注释：//…… 单独行注释：在代码中单起一行注释，注释前最好有一行空行，并与其后的代码具有一样的缩进层级 。如果单行无法完成，则应采用块注释 。注释格式：/* 注释内容 */ 行头注释：在代码行的开头进行注释 。主要为了使该行代码失去意义 。注释格式：// 注释内容 行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释 。一般与代码行后空8（至少4）个格，所有注释必须对齐 。注释格式：代码 + 8（至少4）个空格 + // 注释内容
2、块(block)--块注释：/*……*/ 注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述 。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置 。这种域注释不会出现在HTML报告中 。注释格式通常写成： /* * 注释内容 */

推荐阅读


上一篇：gis软件景观设计，gis软件难学吗

下一篇：thinkphp自定义类放在什么地方，thinkphp自定义错误页面