# require-property-description
* [Context and settings](#user-content-require-property-description-context-and-settings)
* [Failing examples](#user-content-require-property-description-failing-examples)
* [Passing examples](#user-content-require-property-description-passing-examples)
Requires that each `@property` tag has a `description` value.
## Context and settings
|||
|---|---|
|Context|everywhere|
|Tags|`property`|
|Aliases|`prop`|
|Recommended|true|
## Failing examples
The following patterns are considered problems:
````ts
/**
* @typedef {SomeType} SomeTypedef
* @property foo
*/
// Message: Missing JSDoc @property "foo" description.
/**
* @typedef {SomeType} SomeTypedef
* @prop foo
*/
// Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
// Message: Missing JSDoc @prop "foo" description.
/**
* @typedef {SomeType} SomeTypedef
* @property foo
*/
// Settings: {"jsdoc":{"tagNamePreference":{"property":false}}}
// Message: Unexpected tag `@property`
````
## Passing examples
The following patterns are not considered problems:
````ts
/**
* @typedef {SomeType} SomeTypedef
*/
/**
* @typedef {SomeType} SomeTypedef
* @property foo Foo.
*/
/**
* @namespace {SomeType} SomeName
* @property foo Foo.
*/
/**
* @class
* @property foo Foo.
*/
/**
* Typedef with multi-line property type.
*
* @typedef {object} MyType
* @property {function(
* number
* )} numberEater Method which takes a number.
*/
````