google-apps-script - 编写有关类中方法的 jsdoc 文档

Question

我正在用 Google Apps Script 编写一些库，我正在尝试记录它们。我用下面的格式编写了一些类，类中方法的注释没有显示在文档中:

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

   this.myMethod=myMethod;
   ....

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

   function myMethod(){
     ...
   }

}

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

Answer 1

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

支持 Google Apps Script 中的库的 jsdoc 变体不支持您正在寻找的级别的文档，仅支持第一级功能。有一个relevant open bug report对此，但谷歌没有回应。

您仍然可以编写 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