Java基础-runoob

(每篇解析在网页最下方还有笔记!!!!!!!)

https://www.runoob.com/java/java-operators.html

要反复多学几次,主要为了构建知识体系,到时候再细细修改博文(博客园支持修改啊)。

欲速则不达

心急吃不了热豆腐

搞了一上午,越搞越心急

还是上班时间来搞吧

一章一章的整,倒着来

 


Java 文档注释

第三种被称作说明注释,它以 /** 开始,以 */结束。

javadoc 标签

javadoc 工具软件识别以下标签:

标签 描述 示例
@author 标识一个类的作者 @author description
@deprecated 指名一个过期的类或成员 @deprecated description
{@docRoot} 指明当前文档根目录的路径 Directory Path
@exception 标志一个类抛出的异常 @exception exception-name explanation
{@inheritDoc} 从直接父类继承的注释 Inherits a comment from the immediate surperclass.
{@link} 插入一个到另一个主题的链接 {@link name text}
{@linkplain} 插入一个到另一个主题的链接,但是该链接显示纯文本字体 Inserts an in-line link to another topic.
@param 说明一个方法的参数 @param parameter-name explanation
@return 说明返回值类型 @return explanation
@see 指定一个到另一个主题的链接 @see anchor
@serial 说明一个序列化属性 @serial description
@serialData 说明通过writeObject( ) 和 writeExternal( )方法写的数据 @serialData description
@serialField 说明一个ObjectStreamField组件 @serialField name type description
@since 标记当引入一个特定的变化时 @since release
@throws 和 @exception标签一样. The @throws tag has the same meaning as the @exception tag.
{@value} 显示常量的值,该常量必须是static属性。 Displays the value of a constant, which must be a static field.
@version 指定类的版本 @version info

 

javadoc 输出什么

/** 
* 这个类演示了文档注释 
* @author Ayan Amhed 
* @version 1.2 */ 
public class SquareNum { 
/** 
* This method returns the square of num. 
* This is a multiline description. You can use 
* as many lines as you like. 
* @param num The value to be squared. 
* @return num squared. 
*/ 
public double square(double num) { 
  return num * num; 
} 
/** 
* This method inputs a number from the user. 
* @return The value input as a double. 
* @exception IOException On input error. 
* @see IOException 
*/ 
public double getNumber() throws IOException { 
  InputStreamReader isr = new InputStreamReader(System.in); 
  BufferedReader inData = new BufferedReader(isr); 
  String str; str = inData.readLine(); 
  return (new Double(str)).doubleValue(); 
} 
/** 
* This method demonstrates square(). 
* @param args Unused. 
* @return Nothing. 
* @exception IOException On input error. 
* @see IOException 
*/ 
public static void main(String args[]) throws IOException {

定义成模板在自己的 IDE 上,这样每次通过快捷键就可自动帮你输出在方法中,省去了很多时间,也使代码更加规范。

首先是在文件头部添加:

/*
 * <p>项目名称: ${project_name} </p> 
 * <p>文件名称: ${file_name} </p> 
 * <p>描述: [类型描述] </p>
 * <p>创建时间: ${date} </p>
 * <p>公司信息: ************公司 *********部</p> 
 * @author <a href="mail to: *******@******.com" rel="nofollow">作者</a>
 * @version v1.0
 * @update [序号][日期YYYY-MM-DD] [更改人姓名][变更描述]
 */

方法:

/**
 * @Title:${enclosing_method}
 * @Description: [功能描述]
 * @Param: ${tags}
 * @Return: ${return_type}
 * @author <a href="mail to: *******@******.com" rel="nofollow">作者</a>
 * @CreateDate: ${date} ${time}</p> 
 * @update: [序号][日期YYYY-MM-DD] [更改人姓名][变更描述]     
 */

getter 和 setter

/**
 * 获取  ${bare_field_name}
 */
/**
 * 设置   ${bare_field_name} 
 * (${param})${field}
 */
 

J


J


J


J

猜你喜欢

转载自www.cnblogs.com/lovesufang/p/12544131.html