Java特殊注释(XXX,TODO,FIXME)解释说明

测试代码

/**   
 * Filename:    Test.java   
 * Copyright:   Copyright (c)2016  
 * Company:     Yves  
 * @version:    1.0    
 * Create at:   2017-10-16
 * Description:  
 *
 * Author       Yves He 
 */
package cn.com.yves;

public class Test {

    public static void xxx() {
        // XXX 勉强可以工作,但是性能差等原因.
    }

    public static void todo() {
        // TODO 表示需要实现,但目前还未实现的功能.
    }

    public static void fixme() {
        // FIXME 代码是错误的,不能工作,需要修复.
    }

}


特殊注释说明:

TODO: + 说明:
如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。

FIXME: + 说明:
如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。

XXX: + 说明:
如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。

Eclipse中Task视图
在Eclipse中,TODO、FIXME和XXX注释都会被Eclipse的task视图所收集。效果图如下:
20171016135155361png

原文链接:http://www.yveshe.com/articles/2018/07/18/1531927831925.html

猜你喜欢

转载自blog.csdn.net/weberhuangxingbo/article/details/86610712