Java 中的@param 注解如何使用?

注解，@param是参数的解释。如：/***@param s 这里表示对s的文字说明，描述*/public void aa(String s){}一般java中@表示注解，解释一个方法，类，属性的作用。

一. 基本概念

Java是一种可以撰写跨平台应用软件的面向对象的程序设计语言。Java 技术具有卓越的通用性、高效性、平台移植性和安全性，广泛应用于PC、数据中心、游戏控制台、科学超级计算机、移动电话和互联网，同时拥有全球最大的开发者专业社群。

二. 研发背景

Java是由Sun Microsystems公司推出的Java面向对象程序设计语言（以下简称Java语言）和Java平台的总称。Java由James Gosling和同事们共同研发，并在1995年正式推出。Java最初被称为Oak，是1991年为消费类电子产品的嵌入式芯片而设计的。1995年更名为Java，并重新设计用于开发Internet应用程序。用Java实现的HotJava浏览器（支持Java applet）显示了Java的魅力：跨平台、动态Web、Internet计算。

1、单行(single-line)--短注释：//…… 单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。 注释格式：/* 注释内容 */ 行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式：// 注释内容 行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。 注释格式：代码 + 8（至少4）个空格 + // 注释内容

2、块(block)--块注释：/*……*/ 注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成： /* * 注释内容 */

3、文档注释：/**……*/ 注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符 /**......*/ ...

package com.tuobao.test

import java.io.File

import java.io.FileOutputStream

import java.io.FileWriter

import java.util.Iterator

import java.util.List

import org.dom4j.Attribute

import org.dom4j.Document

import org.dom4j.DocumentHelper

import org.dom4j.Element

import org.dom4j.io.OutputFormat

import org.dom4j.io.SAXReader

import org.dom4j.io.XMLWriter

public class testDom4j {

private static final String path = "f:" + java.io.File.separator

+ "eee.xml"

/**

* @param args

*/

public static void main(String[] args) {

// System.out.println(createXMLFile(path))

// System.out.println(modiXMLFile(path, path))

System.out.println(formatXMLFile(path))

}

/**

* 建立一个XML文档,文档名由输入属性决定

*

* @param param

*filename 需建立的文件名

* @return返回 *** 作结果, 0表失败, 1表成功

*/

public static int createXMLFile(String filename) {

/** 返回 *** 作结果, 0表失败, 1表成功 */

int returnValue = 0

/** 建立document对象 */

Document document = DocumentHelper.createDocument()

/** 建立XML文档的根books */

Element booksElement = document.addElement("books")

/** 加入一行注释 */

booksElement.addComment("This is a test for dom4j, holen, 2004.9.11")

/** 加入第一个book节点 */

Element bookElement = booksElement.addElement("book")

/** 加入show属性内容 */

bookElement.addAttribute("show", "yes")

/** 加入title节点 */

Element titleElement = bookElement.addElement("title")

/** 为title设置内容 */

titleElement.setText("Dom4j Tutorials")

/** 类似的完成后两个book */

bookElement = booksElement.addElement("book")

bookElement.addAttribute("show", "yes")

titleElement = bookElement.addElement("title")

titleElement.setText("Lucene Studing")

bookElement = booksElement.addElement("book")

bookElement.addAttribute("show", "no")

titleElement = bookElement.addElement("title")

titleElement.setText("Lucene in Action")

/** 加入owner节点 */

Element ownerElement = booksElement.addElement("owner")

ownerElement.setText("O'Reilly")

try {

/** 将document中的内容写入文件中 */

XMLWriter writer = new XMLWriter(new FileWriter(new java.io.File(

filename)))

writer.write(document)

writer.flush()

writer.close()

/** 执行成功,需返回1 */

returnValue = 1

} catch (Exception ex) {

returnValue = 0

ex.printStackTrace()

}

return returnValue

}

/**

* 修改XML文件中内容,并另存为一个新文件 重点掌握dom4j中如何添加节点,修改节点,删除节点

*

* @param filename

*修改对象文件

* @param newfilename

*修改后另存为该文件

* @return 返回 *** 作结果, 0表失败, 1表成功

*/

public static int modiXMLFile(String filename, String newfilename) {

int returnValue = 0

try {

SAXReader saxReader = new SAXReader()

Document document = saxReader.read(new java.io.File(filename))

/** 修改内容之一: 如果book节点中show属性的内容为yes,则修改成no */

/** 先用xpath查找对象 */

List list = document.selectNodes("/books/book/@show")

Iterator iter = list.iterator()

while (iter.hasNext()) {

Attribute attribute = (Attribute) iter.next()

if (attribute.getValue().equals("yes")) {

attribute.setValue("no")

}

}

/**

* 修改内容之二: 把owner项内容改为"测试修改"

* 并在owner节点中加入date节点,date节点的内容为2004-09-11,还为date节点添加一个属性type

*/

list = document.selectNodes("/books/owner")

iter = list.iterator()

if (iter.hasNext()) {

Element ownerElement = (Element) iter.next()

ownerElement.setText("测试修改")

Element dateElement = ownerElement.addElement("date")

dateElement.setText("2008-09-11")

dateElement.addAttribute("type", "日期")

}

/** 修改内容之三: 若title内容为Dom4j Tutorials,则删除该节点 */

list = document.selectNodes("/books/book")

iter = list.iterator()

while (iter.hasNext()) {

Element bookElement = (Element) iter.next()

Iterator iterator = bookElement.elementIterator("title")

while (iterator.hasNext()) {

Element titleElement = (Element) iterator.next()

if (titleElement.getText().equals("Dom4j Tutorials")) {

bookElement.remove(titleElement)

}

}

}

try {

/** 格式化输出,类型IE浏览一样 */

OutputFormat format = OutputFormat.createPrettyPrint()

/** 指定XML编码 */

// format.setEncoding("GBK")

/** 将document中的内容写入文件中 */

// XMLWriter writer = new XMLWriter(new FileWriter(new

// File(newfilename)),format)

// 保证编码为UTF-8，支持中文写入

XMLWriter writer = new XMLWriter(new FileOutputStream(new File(

newfilename)), format)

writer.write(document)

writer.flush()

writer.close()

/** 执行成功,需返回1 */

returnValue = 1

} catch (Exception ex) {

returnValue = 0

ex.printStackTrace()

}

} catch (Exception ex) {

ex.printStackTrace()

}

return returnValue

}

/**

* 格式化XML文档,并解决中文问题

*

* @param filename

* @return

*/

public static int formatXMLFile(String filename) {

int returnValue = 0

try {

SAXReader saxReader = new SAXReader()

Document document = saxReader.read(new File(filename))

XMLWriter writer = null

/** 格式化输出,类型IE浏览一样 */

OutputFormat format = OutputFormat.createPrettyPrint()

/** 指定XML编码 */

format.setEncoding("utf-8")

writer = new XMLWriter(new FileWriter(new File(filename)), format)

writer.write(document)

writer.flush()

writer.close()

/** 执行成功,需返回1 */

returnValue = 1

} catch (Exception ex) {

returnValue = 0

ex.printStackTrace()

}

return returnValue

}

}

这个希望对你有用。。

---