菜鸡的Java笔记 api 文档

package 包的用法为什么需要 package ? 为了解决类之间的重名问题为了便于管理类:合适类位于合适的包 package 怎么用? 通常是类的第一句非注释性语句包名:域名倒着写即可,在加上模块名,并与内部管理类注意事项: 写项目时都要加包,不要使用默认包 com.gao 和 com.gao.car 这两个包没有包含关系,是两个完全独立的包,只是逻辑上看…

Java：API文档；文档注释中的javadoc标记；官方API；自己动手给项目建一个API文档

1.什么是API文档在Java语言中有3种注释 //单行注释 /* 多行注释 */ /** * 文档注释 */ API(应用程序接口)文档就是用javadoc命令提取文档注释生成的,html格式,用浏览器查看. API文档既然是由文档注释生成的,那么文档注释怎么写呢? 首先,文档注释必须放在类和方法的前面,格式也要准确. 其中,要写清楚类和方法的功能,以及方法传入的形参和返回值具体是什么. 一般来说,只默认提取public和protected修饰的类.接口.方法.成员变量.构造器.内部类的说明…

Java 的 Api 文档生成工具 JApiDocs 程序文档工具

JApiDocs 详细介绍简介 JApiDocs 是一个符合 Java 编程习惯的 Api 文档生成工具.最大程度地利用 Java 的语法特性,你只管用心设计好接口,添加必要的注释,JApiDocs 会帮你导出一份漂亮的 Html 文档,并生成相关的 Java 和 Object-C 相关数据模型代码,从此,Android 和 IOS 的同学可以少敲很多代码了,你也不需要费力维护接口文档的变化,只需要维护好你的代码就可以了. 一个简单的示例. 特性以一个 Controller 作为一组接口导出…

【转载】Java Restful API 文档生成工具 smart-doc

谁说生成api文档就必须要定义注解? 谁说生成接口请求和返回示例必须要在线? 用代码去探路,不断尝试更多文档交付的可能性. 如果代码有生命,为什么不换种方式和它对话! 一.背景没有背景.就自己做自己的背景在当今各种盛行的前后端分离.restful service开发过程中,接口文档是必不可少的.对于前后端分离的开发中,后端开发需要将接口写好后需要告诉前端工程师接口的请求参数.响应示例等重要信息,而对于对外暴露的restful接口服务,我们提供接口也是需要具备相同的接口文档的. 但是对于后端工…

菜鸡的Java笔记第三十 - java 异常的捕获及处理

异常的捕获及处理 1.异常的产生分析以及所带来的影响 2.异常的处理的基本格式 3.异常的处理流程 4.异常的处理模式 5.自定义异常 java中最为优秀的设计就在于异常的处理上,而且很简单认识异常异常都是从Throwable类派生出来的,而Throwable类是直接从Object类继承而来.你可以在Java SE官方API文档中获取更多关于它们的知识. 异常通常有四类: Err…

Java开发API文档资源

<netty> http://netty.io/4.1/api/index.html < Spring FrameWork > 1 http://spring.io/ 2 http://projects.spring.io/spring-framework/ 3 所有版本的springMVC文档,内含详细Demo与解析 http://docs.spring.io/spring/docs/ 4 http://docs.spring.io/spring/docs/4.3.9.…

菜鸡的Java笔记

1.注释在JAVA中对于注释有三种: 单行注释:// 多行注释:/*--*/ 文档注释:/**--*/ 2.关键字和标识符在程序中描述类名称,方法名称,变量等概念就需要使用标识符来定义.而在JAVA中表标识符定义原则:由字母,数字,_,$所组成,其中不能用以数字开头,不能用JAVA保留字(关键字). 解释: 以后自己写的代码都建议用字母表示系统生成的代码,可以使用开头"_"(现在跟自己没有关系); $ 作为标识符组成,但是与你们的编写代码无关,有其自己特殊的使用环境. 实际中定义…

菜鸡的Java笔记 java基础类库 BaseClassLibrary

java基础类库 BaseClassLibrary StringBuffer 类的特点 StringBuffer,StringBuilder,String 类之间的关系 StringBuffer 类 String 类有哪些特点? 字符串常量就是String 类的匿名对象,一旦字符串定义则不可改变 String 类对象可以使用直接赋值或者构造方法实例化,前者可以自动入池,又不会产生垃圾空间 …

菜鸡的Java笔记第三十三 - java 泛型

泛型 GenericParadigm 1.泛型的产生动机 2.泛型的使用以及通配符 3.泛型方法的使用 JDK1.5 后的三大主要新特性:泛型,枚举,Annotation 泛型的产生背景在 Java SE 5.0 以前操作集合有许多缺点: 一是从集合取出对象时,需要执行类型转换操作,我们在前面讲过,集合中存储都是以 Object 对象进行存储的,这无疑让我们的操作变得麻烦. 二是由于没有类型检…

菜鸡的Java笔记第十四 String 类常用方法

/*String 类常用方法将所有String类的常用方法全部记下来,包括方法名称,参数作用以及类型一个成熟的编程语言,除了它的语法非常完善之外,那么也需要提供有大量的开发类库而需要知道的java的类库除了本身提供的JDKDoc之外还会有大量的本次操作主要是以文档的查找为主,文档没有中文的,只有英文或者是日文. 一般来讲每一份文档的组成都会包含有如下几个部分: 1.类的定义以及实现的父类,父接口,子类,子接口等 2.类的一些使用的…

【菜鸡的Java笔记 api 文档】的更多相关文章