@param和@return对Google App Scripts的评论意味着什么？

Question

我一直在图书馆看到这种事情，我目前正在与之合作：

/**
 * Builds a pie chart from data in a specific column.
 *
 * @param  {Object[][]} data a JavaScript 2d array
 * @param  {int} columnIndex the index of the column from which the chart should be created
 * @param  {int} optfilter the index of the column used to add a filter to the chart
 * @return {ChartPanel} a panel containing chart & filter. 
 */

我在使用该库的代码中看到了有助于自动完成的内容。它做什么以及如何运作？

Answer 1

如果您遵循指定的语法，有些工具可以根据注释构建文档。

@param开始一行记录函数的参数，@return记录带有类型和描述的预期返回值。

Answer 2

你是对的。这些东西是JavaDoc的一部分，并提供函数（以及属性和类）的文档。类似于.NET上的Intellisense弹出提示。

eclipse中的例子：

（Image Source）

Answer 3

它们是自动文档系统的一部分，通过它可以快速获取有关函数参数和返回类型的信息。