tawords-docs/docs/manual/4. 应用开发文档/2. 规范（待完善）/1. 本项目遵循的注释规范.md

@since 表示从那个版本开始就有这个类/接口/方法 @deprecated 表示不建议使用该类/接口/方法 @exception 标注Runtime异常 @throws 标注非Runtime异常

类、接口

/**
 * 〈一句话功能简述〉LogManager 类集中控制对日志读写的操作。
 * 〈功能详细描述〉全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器，读取或写入符合条件的日志纪录。
 * @author [作者]张三，李四，王五
 * @version [版本号, YYYY-MM-DD]1.2, 2001-03-25
 * @see [相关类/方法]LogIteraotor
 * @see [相关类/方法]BasicLog
 * @since [产品/模块版本]CommonLog1.0
 */

方法

/**
 * 〈一句话功能简述〉
 * 〈功能详细描述〉
 * @param [参数1] [参数1说明]
 * @param [参数2] [参数2说明]
 * @return [返回类型说明]
 * @exception/throws [违例类型] [违例说明]
 * @see [类、类#方法、类#成员]
 * @deprecated
 */