为类中的方法编写 jsdoc 文档答案

【问题标题】：Writing jsdoc documentation on methods inside a class为类中的方法编写 jsdoc 文档
【发布时间】：2013-01-31 09:10:36
【问题描述】：

我正在用 Google Apps Script 编写一些库，并且正在尝试记录它们。我已经编写了一些格式如下的类，并且类中的方法的 cmets 没有出现在文档中：

/**
* My comments here
*/
function MyBeautifulObject(){

   this.myMethod=myMethod;
   ....

   /**
   * This comment doesn't show up
   */

   function myMethod(){
     ...
   }

}

知道如何实现这一目标吗？

【问题讨论】：

“文档”是什么意思？
另外，你可能想关注this issue。
嗨菲尔！感谢您的回答！是的，我说的是 jsdoc，如果你去你正在使用的库，点击一个库的标题，然后查看它的文档，你可以获得它。
我正在编写要为其添加文档的类。但是对于内部方法，它不会显示出来。
这能回答你的问题吗？ Google Apps Script Auto Generated Library Documentation

标签： google-apps-script documentation jsdoc

【解决方案1】：

这个问题可能是重复的...this answer certainly is。

Google Apps 脚本中的库支持的 jsdoc 变体不支持您要查找的级别的文档，仅支持一级函数。对此有一个relevant open bug report，但谷歌没有回应。

您仍然可以编写 jsdoc 标签，并在 Google 基础架构之外生成文档。查看How to preview jsdoc comments in google doc scripts 以获取有关如何预览 jsdoc cmets 的一些指示。您可以获取 jsdoc3 的输出并将其发布到网站上，以便将您的文档提供给您的社区。p>

其他相关/可能重复的帖子：

【讨论】：

【解决方案2】：

如果您正在使用 TypeScript，我们已经构建了一个包来帮助解决这个问题：

https://github.com/maelcaldas/clasp-types

我们使用它为我们的 OO 库和使用 Typescript 编写的客户端 API 生成自动完成功能。

【讨论】：