IDEA注释样例笔记

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/superman_xxx/article/details/78627758

一、文件头注释

/**
*　　　　　　　 ┏┓       ┏┓+ +
*　　　　　　　┏┛┻━━━━━━━┛┻┓ + +
*　　　　　　　┃　　　　　　 ┃
*　　　　　　　┃　　　━　　　┃ ++ + + +
*　　　　　　 █████━█████  ┃+
*　　　　　　　┃　　　　　　 ┃ +
*　　　　　　　┃　　　┻　　　┃
*　　　　　　　┃　　　　　　 ┃ + +
*　　　　　　　┗━━┓　　　 ┏━┛
*               ┃　　  ┃
*　　　　　　　　　┃　　  ┃ + + + +
*　　　　　　　　　┃　　　┃　Code is far away from     bug with the animal protecting
*　　　　　　　　　┃　　　┃ + 　　　
*　　　　　　　　　┃　　　┃
*　　　　　　　　　┃　　　┃　　+
*　　　　　　　　　┃　 　 ┗━━━┓ + +
*　　　　　　　　　┃ 　　　　　┣┓
*　　　　　　　　　┃ 　　　　　┏┛
*　　　　　　　　　┗┓┓┏━━━┳┓┏┛ + + + +
*　　　　　　　　　 ┃┫┫　 ┃┫┫
*　　　　　　　　　 ┗┻┛　 ┗┻┛+ + + +
*/
/**
* @PACKAGE_NAME: ${PACKAGE_NAME}
* @Description: TODO(Describe the role of this JAVA class)
* @author YanchaoMa [email protected]
* @date ${DATE} ${TIME}
* 
* 
*/

二、方法注释

/**
* @Description: $METHOD_NAME$ TODO(Describe the role of this method)
* @param $METHOD_PARAMETERS$
* @return $RETURN$
*/

三、类文件注释

/**
* @PACKAGE_NAME: $PACKAGE_NAME$.$CLASS_NAME$
* @Description: TODO(Describe the role of this JAVA class)
* @author YanchaoMa yanchaoma@foxmail.com
* @date $DATE$ $TIME$
* 
* 
*/

、