相关疑难解决方法(0)

如何创建自定义的javadoc标签,例如@pre/@post？我发现了一些解释它的链接,但我没有运气.这些是一些链接:

http://www.developer.com/java/other/article.php/3085991/Javadoc-Programming.html

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html

我正在尝试将customTag添加到jsdoc.我在plugins目录中创建了一个文件,如下所示:

method.js

exports.defineTags = function(dictionary) {
    dictionary.defineTag("methodHttp", {
        mustHaveValue: true,
        canHaveType: false,
        canHaveName: true,
        onTagged: function(doclet, tag) {
            doclet.methodHttp = tag.value;
        }
    });
};

然后我加入了我的conf.json:

{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [ "plugins/method" ],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "default": {
            "outputSourceFiles": true
        }
    },
    "jsVersion": 180
}

现在我尝试在我的模板上得到这个.我在method.tmpl上.

我试过了:

self.find('methodHttp')[0]
data.methodHttp[0]
data.methodHttp

但它不起作用.我的代码出了什么问题？

是否有针对包含副作用的Java / JVM语言方法编写javadocs的标准或最佳实践？

我定义了一个void方法，该方法修改了方法参数之一，但不知道如何记录实际的返回值（因为没有实际的返回值）。

/**
  * @param obj - reference object
  * @return obj - obj.name is changed to 'hello' //TODO figure out javadoc annotation
 */
void methodName(Object obj) {
   if (obj != null) {
       obj.name = "hello";
   }
}

似乎没有标记对象上副作用的好方法，因为@param和@return批注并不能真正指示正在发生的事情。