JAVA idea代码提示接口方法【xxxxxx】必须使用javadoc注释

接口方法【xxxxxx】必须使用javadoc注释 
 Inspection info: 
所有的抽象方法(包括接口中的方法)必须要用javadoc注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。 说明:如有实现和调用注意事项,请一并说明。

    /**
     * fetch data by rule id
     * 
     * @param ruleId rule id
     * @param page page number
     * @param jsonContext json format context
     * @return Result<XxxxDO>
     */
    Result<XxxxDO> fetchDataByRuleId(Long ruleId, Integer page, String jsonContext);


版权声明:本文为ChunwaiLeung原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。