Question

我一直收到这个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>
 */

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

Answer 1

来自jsdoc-format规则说明：

对JSDoc注释强制执行以下规则（注释开始   与/ **）：


每行包含一个星号，星号必须对齐

每个星号后面必须跟一个空格或换行符（第一个和最后一个除外）

每行上星号前面的唯一字符必须是空格字符

一行注释必须以/ **开头，以* /
结尾

我从comment看到你有间距问题。

Answer 2

即使看起来像对准星星也不是您的问题，但我还是编写了这个小脚本来修复您所有的打字稿文件：https://github.com/Marr11317/starAligner。

希望有些人会发现它对您有帮助...

Answer 3

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

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

来自

/**
 *
 */

已修复

/*
*
*/

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

tslint错误：jsdoc中的Asterik必须对齐

3 个答案: