注释模板

发布时间 2023-09-11 11:34:32作者: AmorFati404
教程来源比较杂,出处不明,自己摸索着改了一点
  • javadoc

平常用showdoc写文档,又懒得装软件,showdoc提供的脚本还是蛮方便的

*
	* showdoc
	* @catalog 测试文档/用户相关
    * @author 
	* @title 用户注册
	* @description 用户注册的接口
    * @date $date$ $time$$param$ $return$
	* @method post
	* @url 
	* @param username 必选 string 用户名  
	* @param password 必选 string 密码  
	* @param name 可选 string 用户昵称  
	* @return {"error_code":0,"data":{"uid":"1","username":"12154545","name":"吴系挂","groupid":2,"reg_time":"1436864169","last_login_time":"0"}}
	* @return_param groupid int 用户组id
	* @return_param name string 用户昵称
	* @remark 这里是备注信息
*/
  • Class注释
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * @author amorfati
 * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */
public class ${NAME} {
}
  • interface注释
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * @author amorfati
 * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */
public interface ${NAME} {
}