---
url: /docs/guide/usage/linter/rules/jsdoc/require-property-description.md
---

### 功能说明

要求所有 `@property` 标签都包含描述。

### 为什么这很糟糕？

属性的描述应该被记录下来。

### 示例

以下是此规则的**错误**代码示例：

```javascript
/**
 * @typedef {SomeType} SomeTypedef
 * @property {number} foo
 */
```

以下是此规则的**正确**代码示例：

```javascript
/**
 * @typedef {SomeType} SomeTypedef
 * @property {number} foo Foo.
 */
```

## 如何使用

## 版本

此规则于 v0.2.18 中添加。

## 参考资料