6

我不断收到这个 tslint 错误，看不出代码有什么问题。有没有人看到下面的 jsdoc asteriks 没有正确对齐的问题：

/**
 * @ngdoc directive
 * @module ers.components.button
 * @scope
 * @transclude
 * @data
 * @binding
 * @name ersButton
 * @restrict E
 * @constructor
 * 
 * @description
 * 
 * A button performs the defined action when the user clicks it.
 * 
 * - Buttons can only consist of text and/or an icon.
 * - Buttons must contain either a click event, an href, an ui-sref, or a type (for form actions).
 * - Buttons labels should be clear. Limit the button text (less is more).
 * 
 * ### Usage
 * 
 * - Use <b>Primary Buttons</b> for primary actions (for example, "Submit", "Login", or "Save"). 
 * Avoid having multiple primary buttons on the same screen.
 * - Use <b>Secondary Buttons</b> for secondary actions that accompany the primary call-to-action (for example, "Reset" or "Cancel").
 * - Use <b>Icon Buttons</b> only for special use cases where standard label buttons are too large to use (for example, Tool Bars).
 *   
 * ### Examples
 * 
 * #### Standard Buttons
 * 
 * Primary and secondary buttons.
 *
 * <code-editor identifier="example1" data-title="Basic Buttons" html-content-url="demos/ersButton/basic/index.html" 
 * js-content-url="demos/ersButton/basic/script.js" css-content-url="demos/ersButton/basic/styles.css" 
 * content-mode="html"></code-editor>
 */

几乎下面的每一行都给了我同样的错误。

4

4 回答 4

4

在我的 Angular 9 项目中，我能够得到 lint 错误

filename.ts:13:1 - asterisks in jsdoc must be aligned

从

/**
 *
 */

固定的

/*
*
*/

不知道为什么，因为多行注释的js-doc 规则说它需要两个星号。

于 2021-04-15T18:06:39.190 回答
4

来自jsdoc-format规则描述：

以下规则适用于 JSDoc 注释（以 /** 开头的注释）：

  • 每行包含一个星号，并且星号必须对齐
  • 每个星号后面必须跟一个空格或换行符（第一个和最后一个除外）
  • 每行星号前的唯一字符必须是空白字符
  • 一行注释必须以 /** 开头并以 */ 结尾

正如我从您的评论中看到的那样，您有间距问题。

于 2017-06-02T21:05:56.403 回答
0

我遇到过同样的问题：

错误：

/**
*
*
* 
*/

使固定：

/**
 *
 *
 * 
 */
于 2021-09-27T07:17:53.720 回答
0

尽管看起来对齐星星不是您的问题，但我只是制作了这个小脚本来修复您所有的打字稿文件：https ://github.com/Marr11317/starAligner 。

希望对某些人有所帮助...

于 2020-08-11T04:18:37.413 回答