给客户提供jar包,还要给一份API文档,于是今天get了新技能:用AS自动生成Java Doc。
前提是,注释要写好啊!注释可以加一些h5标签,用于换行等,举个栗子:
/**
* Store certificate or PVK to Q20
*
* @param type data type<p>
* 0x00 ROOT_PUK_CERT<p>
* 0x01 ISSU_PUK_CERT<p>
* 0x02 POI_PUK_CERT<p>
* 0x03 POI_PVK<p>
* @param data The certification/PVK data
* @return <p>
* {@link RetCode}
*/
public int storeData(int type, byte[] data){
return mSdkImp.storeData(type, data);
}
这段注释表明方法的功能、参数、返回值分别是什么,并且用@link 和返回码类链接。
看看效果:
还挺明了的。接下来贴步骤图啦:
一、Tools->Generate JavaDoc...
二、基本设置,按照图上来就可以
三、新增Filter
这里自定义范围直接选模块的话,它会一股脑给你全生成文档,我们还是要筛选一下的,点击旁边的"...",添加一个filter,名字随便取啥。
在这里,把要生成文档的类选上,或者除去,一半来说生成主要的方法类,返回码类就可以啦,全部设置好后,点ok就可以生成Java Doc,目录结构如下: