在 Angular 6 项目中，@brief 是什么意思？答案

【问题标题】：In an Angular 6 project, what does @brief mean?在 Angular 6 项目中，@brief 是什么意思？
【发布时间】：2019-09-04 04:21:42
【问题描述】：

我有一个新的 Angular 6 项目，我注意到有一些看起来像这样的散列 cmets：

/** @brief the displayed list of vehicles */

还有这个：

/** @brief dummy database of vehicles */

而这个“@brief”是蓝色的，那么这个“@brief”是什么意思？

【问题讨论】：

【解决方案1】：

@brief 将有助于文档。您使用@brief 编写的任何代码都将用于生成文档。您可以使用任何工具生成文档。

【讨论】：

【解决方案2】：

这是 JavaScript 注释块中的 JSDoc 文档语法。

不过，@brief 标签不是标准标签，似乎是从 doxygen 借来的。

最接近的 JSDoc 标记是 @summary tag，意思是“完整描述的较短版本”。

【讨论】：