java 中的几种注释方式

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了java 中的几种注释方式相关的知识,希望对你有一定的参考价值。

java 中的几种注释方式都是怎么样的

我看动力节点的java基础大全301集教中的三种注释方法:

1、单行注释   //注释的内容

2、多行注释  /*......*/

3、/**......*/,这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。

下面介绍一下Javadoc的标记:

特别声明:  

(1)javadoc针对public类生成注释文档

(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

    <span style="font-size:18px;">*/  

    /**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()!");  

      

    </span>  

    [java] view plain copy

    <span style="font-size:18px;">import java.io.IOException;  

    /**javadoc注释内容 

    *@since 1.0 

    *@version 1.1 

    *@author Blue Jey 

    *<br>链接到另一个文档@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";  

      

     </span>  

    注意:

    如果源文件中有用到@version,@author标记,则在执行javadoc命令时,要加-version -author 

    javadoc -version -author -d doc *.java

    (其中用-version用于提取源文件中的版本信息 -author用于提取源文件中的作者信息)

参考技术A 三种类型:
1、单选注释:符号是://
2、块注释: 符号是: /* */ 可以跨多行
3、javadoc注释: 符号是: /** */ 可以跨多行,
生成javadoc时,这样的注释会被生成标准的javaapi注释。
参考技术B 三种类型:
1、单选注释:符号是://
2、块注释: 符号是: /* */ 可以跨多行
3、javadoc注释: 符号是: /** */ 可以跨多行,
生成javadoc时,这样的注释会被生成标准的javaapi注释。
参考技术C 1、单选://
2、多行: /* */
3、javadoc注释: /** */ (一般用于某方法或类前面,其它地方调用时,放鼠标上面会看到注释内容)
参考技术D // 单行注释
/*
*
*/ 多行和文本注释

java Webservice都有哪几种方式啊,哪种方式比较好啊

如题,公司让我做程序的接口,但是查询了一下,java有好几种接口方式,我个人觉得axis2比较好配置,但是不知道是不是最佳的,请对WS比较熟练的高手给点建议

webservice的应用已经越来越广泛了,下面介绍几种在Java体系中开发webservice的方式,相当于做个记录。
1.Axis2
Axis是apache下一个开源的webservice开发组件,出现的算是比较早了,也比较成熟。这里主要介绍Axis+eclipse开发webservice,当然不用eclipse也可以开发和发布webservice,只是用eclipse会比较方便。

(1)下载eclipse的Java EE版本

(2)下载axis2

(3)下载eclipse的axis2插件
Axis2_Codegen_Wizard
Axis2_Service_Archiver

推荐使用1.3的版本

(4)eclipse安装axis2插件
1)在任意目录下新建一个Axis2文件夹,在该文件夹下新建eclipse目录,在eclipse目录中新建plugins目录和features目录,例如:D:\programSoftware\eclipse-SVN\Axis2\eclipse;
2)把下载的axis2插件解压,并把解压的文件放到新建的eclipse的plugins目录下;
3)在%eclipse_home%的目录下新建links目录,并在links目录下新建axis2.link文件,内容为:path=D:\programSoftware\eclipse-SVN\Axis2;
4)重启eclipse,点击·file-new-other,如果看到Axis2 Wizards,则表明插件安装成功。

(5)安装axis2

(6)使用eclipse新建web工程,创建一个普通java类,至少包含一个方法。

(7)发布webservice
1)点击eclipse的File-New-other,打开Axis2 Wizards,选择Axis2 Service Archiver,然后Next;
2)选择Class File Location,也就是类文件存放路径,注意:只选到classes目录,不要包括包文件夹,然后Next;
3)选择Skip WSDL,然后Next
4)一路Next到Select the Service XML file to be included in the Service archive,勾选Generate theservice xml automatically;
5)Service Name-填写你的service名称,Class Name-填写类名称,要包括包名,然后点击load,然后点击Finish,这时webservice就发布成功了;
6)然后到%TOMCAT_HOME%/webapps/axis2/WEB-INF/services 看看是否多了一个.aar的文件;

注意:以上的方式是发布到axis2.war包中,你也可以把生成.aar文件copy到你的实际应用中,同时,你也可以使用eclipse的create webservice功能发布你的webservice,选择axis2生成你的webservice,这样webservice就会部署到你的应用中了。

2.Apche CXF
CXF开发webservice也是比较方便和简单的,它和spring的集成可以说是非常地好。举一个CXF开发webservice的例子吧。
1)在eclipse中新建一个web工程,导入依赖包,如图:

2)编写一个接口,如:

注意:CXF开发的webservice,接口中的方法的参数一定要以这种方式,否则客户端调用的时候CXF服务端会接收不到参数的值,name:参数名称,可不写(建议写上),targetNamespace:命名空间,一定要填写上,默认是包名反过来的顺序,mode:参数类型,IN表示输入。
3)编写一个实现类,实现接口的方法;
4)和spring的集成,编写一个bean文件,如:cxf-beans.xml,内容如下:

Cxf-beans.xml代码
<?xml version="1.0" encoding="UTF-8" ?>

<import resource="classpath:META-INF/cxf/cxf.xml" />
<import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />
<import resource="classpath:META-INF/cxf/cxf-servlet.xml" />

<jaxws:endpoint id="vote" implementor="com.zcl.cxf.service.VoteImpl" address="/Vote" />
</beans>
这个文件比较容易理解,就不解释了。
5)配置CXFServlet
在web.xml文件中配置CXFServlet,加载cxf-beans.xml文件,内容如下:

Web.xml代码

id="WebApp_ID" version="2.5">

<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>WEB-INF/cxf-beans.xml</param-value>
</context-param>

<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

<servlet>
<servlet-name>cxf</servlet-name>
<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>cxf</servlet-name>
<url-pattern>/services/*</url-pattern>
</servlet-mapping>
</web-app>
把工程部署到中间件,如tomcat,就可以访问该webservice了。

3.JDK开发webservice
1)编写一个Java类,如下:

Jdkwebservice.java代码
package demo;

import javax.jws.WebParam;
import javax.jws.WebService;
import javax.xml.ws.Endpoint;

@WebService
public class JdkWebService

return "Just do it," + value + "!";


public static void main(String[] args)



2)运行该java类,在浏览器上就可以访问该webservice了。
注意:开发web工程的时候,这种方法不太友好。我们可以编写一个servlet类,在servlet类的初始化方法中发布webservice,这样我们的中间件服务器启动的时候就会帮我们自动webservice了。

4) xfire
开发WebService的框架不少,每个框架都有各自的有点,最近我用xfire练习开发WebService,下面是开发WebService的小例子,希望对入门的人有些小帮助
1.新建一个java web project命名为TestWebService,将xfire相关的jar包添加到lib目录中,写接口类和实现类

Java代码
package com.lamp.service;

public interface MessageService
public String getName(String name);

[java] view plaincopyprint?
package com.lamp.service;

public interface MessageService
public String getName(String name);


实现类

Java代码
package com.lamp.service.impl;

import com.lamp.service.MessageService;

public class MessageServiceImpl implements MessageService

public String getName(String name)
return "hellow " + name + ", welcome to WebService world";



[java] view plaincopyprint?
package com.lamp.service.impl;

import com.lamp.service.MessageService;

public class MessageServiceImpl implements MessageService

public String getName(String name)
return "hellow " + name + ", welcome to WebService world";




在src目录下新建文件夹META-INF,然后再在其下新建文件夹xfire,在xfire目录下新建配置文件services.xml

Xml代码
<?xml version="1.0" encoding="UTF-8"?>

<service>
<name>MessageService</name>
<serviceClass>com.lamp.service.MessageService</serviceClass>
<implementationClass>com.lamp.service.impl.MessageServiceImpl</implementationClass>
</service>
</beans>
[xml] view plaincopyprint?
<?xml version="1.0" encoding="UTF-8"?>

<service>
<name>MessageService</name>
<serviceClass>com.lamp.service.MessageService</serviceClass>
<implementationClass>com.lamp.service.impl.MessageServiceImpl</implementationClass>
</service>
</beans>

最后在web.xml中配置xfire的servlet

Xml代码
<servlet>
<servlet-name>XFireServlet</servlet-name>
<servlet-class>

</servlet-class>
</servlet>

<servlet-mapping>
<servlet-name>XFireServlet</servlet-name>
<url-pattern>/servlet/XFireServlet/*</url-pattern>
</servlet-mapping>

<servlet-mapping>
<servlet-name>XFireServlet</servlet-name>
<url-pattern>/services/*</url-pattern>
</servlet-mapping>
[xml] view plaincopyprint?
<servlet>
<servlet-name>XFireServlet</servlet-name>
<servlet-class>

</servlet-class>
</servlet>

<servlet-mapping>
<servlet-name>XFireServlet</servlet-name>
<url-pattern>/servlet/XFireServlet/*</url-pattern>
</servlet-mapping>

<servlet-mapping>
<servlet-name>XFireServlet</servlet-name>
<url-pattern>/services/*</url-pattern>
</servlet-mapping>

这样服务器端开发完毕,现在开始客户端的开发
新建一个java project也将xfire相关的jar引入,我用ant在客户端生成代理对象,在项目路径下新建build.xml,代码为

Xml代码
<?xml version="1.0" encoding="UTF-8"?>

<project name="WebService" basedir="." default="gen-webservice">

<property file="build.properties">
</property>

<path id="project-classpath">
<fileset dir="$lib.dir">
<include name="**/*.jar" />
</fileset>
</path>

<target name="gen-webservice">
<taskdef name="wsgen" classname="org.codehaus.xfire.gen.WsGenTask" classpathref="project-classpath" />

<wsgen outputDirectory="$src.dir"
wsdl="$wsdl.dir" package="com.lamp.ws.client" overwrite="true"/>

</target>

</project>
[xml] view plaincopyprint?
<?xml version="1.0" encoding="UTF-8"?>

<project name="WebService" basedir="." default="gen-webservice">

<property file="build.properties">
</property>

<path id="project-classpath">
<fileset dir="$lib.dir">
<include name="**/*.jar" />
</fileset>
</path>

<target name="gen-webservice">
<taskdef name="wsgen" classname="org.codehaus.xfire.gen.WsGenTask" classpathref="project-classpath" />

<wsgen outputDirectory="$src.dir"
wsdl="$wsdl.dir" package="com.lamp.ws.client" overwrite="true"/>

</target>

</project>
参考技术A 这个接口如果是开放提供给其他程序调用,如c、php等不确定编程语言,那就用axis2;
如果调用方也全部是java语言,用cxf
参考技术B 这个有好多种最常用是xfire 这是企业现在都在用的,不过比较老了,但非常稳定,还用就是cxf这个也是企业在用的,这个功能比较多,传输图片流都可以,axis也还行,不过我没用过,
如果你只是轻量级的完全可以用httpclient方式实现,这是现在用的最多的,也是最方便的,
也可以考虑用消息对列如:mq, 像 apache active mq就不错,我以前用过,比IBM收费的mq都好用。看你怎么定吧。如果不是大项目,Webservice是有些重的。最重要的一点,如果对Webservice不熟悉,请写好代码后, 做一下压力测试。不然,你可能不知道自己怎么死的。本回答被提问者采纳
参考技术C 其实都是一种方式,axis2也是实现的JAX-WS,接口是一样的。
用和部署环境一致的库。不过这些也大都兼容。
参考技术D cxf好些,可与spring、EJB等实现良好的结合。用cxf实现jaas也很简单

以上是关于java 中的几种注释方式的主要内容,如果未能解决你的问题,请参考以下文章

SHELL 1Shell脚本基础及执行的几种方式

MyBatis中的几种注解映射

Lombok介绍附比较好用的几种注释推荐

Lombok介绍附比较好用的几种注释推荐

mysql写注释的几种方法

vim的几种多行注释方法