java api接口文档编写

Python020

java api接口文档编写,第1张

Java语言提供了一种强大的注释形式:文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释,然后使用javadoc工具来生成自己的API文档。

文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。

自行搜索一下javadoc即可,示例如下:

/**

 * 类描述

 *

 * @author 作者

 * @version 版本

 */

public class DemoClass {

/**

 * 内部属性:name

 */

private String name

/**

 * Setter方法

 * @return name

 */

public String getName() {

return name

}

/**

 * Getter方法

 * @param name

 */

public void setName(String name) {

this.name = name

}

}

B/S结构(Browser/Server结构)结构即浏览器和服务器结构。它是随着Internet技术的兴起,对C/S结构的一种变化或者改进的结构。在这种结构下,用户工作界面是通过WWW浏览器来实现,极少部分事务逻辑在前端(Browser)实现,但是主要事务逻辑在服务器端(Server)实现,形成所谓三层3-tier结构。这样就大大简化了客户端电脑载荷,减轻了系统维护与升级的成本和工作量,降低了用户的总体成本(TCO)。以目前的技术看,局域网建立B/S结构的网络应用,并通过Internet/Intranet模式下数据库应用,相对易于把握、成本也是较低的。它是一次性到位的开发,能实现不同的人员,从不同的地点,以不同的接入方式(比如LAN, WAN, Internet/Intranet等)访问和操作共同的数据库;它能有效地保护数据平台和管理访问权限,服务器数据库也很安全 。特别是在JAVA这样的跨平台语言出现之后,B/S架构管理软件更是方便、速度快、效果优。

剩余已经发你邮箱里了,记得推荐最佳答案哦

Java开发程序员工作职责

1、完成软件系统代码的实现,编写代码注释和开发文档

2、辅助进行系统的功能定义,程序设计

3、根据设计文档或需求说明完成代码编写,调试,测试和维护

4、分析并解决软件开发过程中的问题

5、协助测试工程师制定测试计划,定位发现的问题

6、配合项目经理完成相关任务目标。