评论中的“@something”字样?
"@something" words in comments?
评论里的这些“@word”是干什么用的?
我在 JavaScript 和其他一些语言中看到过这些。这有一些标准还是专门针对特定工具的?如果有更多类似的东西,有人可以打开这个更高级的评论过程吗?其次,为什么这个例子以两个星号开头?
示例:
/**
* Builds an absolute Path for a project, where
* the files should be stored
*
* @param projectDir String
* @param fileName String (optional)
* @return {String} absolute Path
*/
不,没有标准,但是这种文档评论风格的最流行工具之一是 JSDoc,它大致基于 Java 的 JavaDoc评论。
它可能看起来只是一些预先格式化的约定的审美评论。
但这些注释实际上被开发工具用来提供自动文档生成(如 JSDoc)、语法和类型检查,甚至是获取编译指令(Google Closure minifier)。
2 个星号和 @something
符号都是这些开发工具的约定。
所以如果你永远不会使用这样的开发工具,这个符号纯粹是为了美观。但是,如果您要使用这些工具,那么利用自动化流程将成为您工作流程的一部分。
评论里的这些“@word”是干什么用的?
我在 JavaScript 和其他一些语言中看到过这些。这有一些标准还是专门针对特定工具的?如果有更多类似的东西,有人可以打开这个更高级的评论过程吗?其次,为什么这个例子以两个星号开头?
示例:
/**
* Builds an absolute Path for a project, where
* the files should be stored
*
* @param projectDir String
* @param fileName String (optional)
* @return {String} absolute Path
*/
不,没有标准,但是这种文档评论风格的最流行工具之一是 JSDoc,它大致基于 Java 的 JavaDoc评论。
它可能看起来只是一些预先格式化的约定的审美评论。
但这些注释实际上被开发工具用来提供自动文档生成(如 JSDoc)、语法和类型检查,甚至是获取编译指令(Google Closure minifier)。
2 个星号和 @something
符号都是这些开发工具的约定。
所以如果你永远不会使用这样的开发工具,这个符号纯粹是为了美观。但是,如果您要使用这些工具,那么利用自动化流程将成为您工作流程的一部分。