注释规约

特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫描,经常清理 此类标记。线上故障有时候就是来源于这些标记处的代码。
1)待办事宜(TODO):(标记人,标记时间,[预计处理时间])表示需要实现,但目前还未实现的功能。这实际上是 一个 Javadoc 的标签,
目前的 Javadoc 还没有实现,但已经被广泛使用。只能应用于类,接口和方法(因为它是一个 Javadoc 标签)。
2)错误,不能工作(FIXME):(标记人,标记时间,[预计处理时间])在注释中用 FIXME 标记某代码是错误的,而 且不能工作,需要及时纠正的情况。
posted @ 2022-04-28 10:13  一点也不好  阅读(34)  评论(0)    收藏  举报