编写关于类中方法的jsdoc文档

Question

我正在Google Apps脚本中编写一些库，我正在尝试记录它们。我已经用下面的格式编写了一些类，并且类中的方法注释不会出现在文档中：

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

   this.myMethod=myMethod;
   ....

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

   function myMethod(){
     ...
   }

}

关于如何实现这一目标的任何想法？

Answer 1

此问题可能重复... this answer certainly is。

Google Apps脚本中支持库的jsdoc变体不支持您要查找的级别的文档，只支持第一级功能。此处有relevant open bug report，但Google没有回复。

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

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

• Creating a namespace-like organization in a google apps script library
• Google Apps Script Auto Generated Library Documentation

Answer 2

如果您正在使用TypeScript，我们已经构建了一个旨在为此提供帮助的软件包：

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

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