Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

对文档注释方面的误报 #5

Closed
chriswong opened this issue Oct 30, 2014 · 2 comments
Closed

对文档注释方面的误报 #5

chriswong opened this issue Oct 30, 2014 · 2 comments
Assignees
Labels

Comments

@chriswong
Copy link
Member

目前知道的有:

  • @return 要求换成 @returns 的问题
  • namepaths 中包含 module: 前缀报 error
@chriswong chriswong added the bug label Oct 30, 2014
@chriswong chriswong self-assigned this Oct 30, 2014
@otakustay
Copy link
Member

显示错误如下:

fecs  WARN → line 86, col 8: JSDoc syntax error.

实际代码如下:

/**
 * 启动当前对象
 *
 * 未启动的对象依旧可以通过{@link Locator#.redirect|redirect方法}等的调用来控制地址跳转
 *
 * @method Locator#.start
 *
 * @fires start
 */
exports.start = function () {
    // ...
};

但不知道具体错在哪

@chriswong
Copy link
Member Author

经过测试是 doctrine 的 bug,对 @method 的 name 部分解释不支持 namepaths

显示错误如下:

fecs WARN → line 86, col 8: JSDoc syntax error.
实际代码如下:

/**

  • 启动当前对象
    *
  • 未启动的对象依旧可以通过{@link Locator#.redirect|redirect方法}等的调用来控制地址跳转
    *
  • @method Locator#.start
    *
  • @fires start
    */
    exports.start = function () {
    // ...
    };
    但不知道具体错在哪

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants