如何给 JSDoc 添加标签？

Question

我使用的 Meteor 与普通 JavaScript 相比有一些奇怪的注意事项。我想添加一些标签以使文档更明确。

Meteor.methods({
  /**
  * Upgrade a user's role
  *
  * @where Anywhere
  * @rolerequired 'admin'
  *
  * @module Meteor.methods
  * @method Roles.upgrade
  * @param {String|Object} user the userId or the user document to update
  * @param {String} role the role to add the user to
  * @throws Meteor.Error 401 if the user trying to upgrade was not authorized to do so
  * 
  * @example
  * Meteor.call('Roles.upgrade', Meteor.users.findOne(), function (err) {
    if (!err) {
      console.log('User successfully added to role');
    } else {
      Router.error(401);
    }
  })
  */
  'Roles.upgrade': function (user, role) {
    if (Roles.userIsInRole(this.userId, 'admin')) {
      return Roles.addUserToRoles(user, role);
    } else {
      throw new Meteor.Error(401, "Not authorized to upgrade roles")
    }
  }
});

@where 和 @rolerequired 更具体到这个基于 Meteor 的应用程序。 @where 可以在 devdocs.io.

中看到

如何给JSDoc添加标签？

Answer 1

是的，可以向 JSDoc 添加自定义标签。您需要创建一个 javascript 文件来定义您要添加的标签：

custom_tags.js:

exports.defineTags = function(dictionary) {
  dictionary.defineTag('where', {
    mustHaveValue: true,
    onTagged : function(doclet, tag) {
      doclet.where = doclet.where || [];
      doclet.where.push(tag.value);
    }
  });
};

然后您需要将该 javascript 文件的位置添加到 conf.json 中，该文件将您的插件列为路径的一部分

conf.json:

{
  "plugins": [
    "plugins/test"
  ],
}

最后，您需要为默认模板更新 .tmpl 文件，以便在生成的文档中呈现您的信息。或者您可以创建自己的模板并定义自己的解析以将您的标签添加到生成的文档中。

如何给 JSDoc 添加标签？

How to add tags to JSDoc?

javascript

documentation

documentation-generation

jsdoc3