logo标签列表

在一个类中编写有关方法的jsdoc文档

google-apps-scriptdocumentationlibrariesjsdoc
4
我正在使用Google Apps Script编写一些库，尝试为它们编写文档。我按照下面的格式编写了一些类，并且类中方法的注释在文档中未显示：
/**
* My comments here
*/
function MyBeautifulObject(){

   this.myMethod=myMethod;
   ....

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

   function myMethod(){
     ...
   }

}

有什么想法可以实现这个吗？
“文档”是什么意思？ - Phil Bozak
另外，您可能想要关注此问题。链接 - Phil Bozak
嗨Phil！感谢您的回答！是的，我在谈论jsdoc，如果您进入正在使用的库，单击一个库的标题并查看其文档，就可以获得它。 - Vic Seedoubleyew
我正在编写一些类，并希望添加文档注释，但对于内部方法，它并未显示出来。 - Vic Seedoubleyew
1
这个回答解决了你的问题吗？Google Apps Script自动生成的库文档 - Sunny Patel
2个回答
2

这个问题可能是一个重复的问题...这个答案肯定是。

在Google Apps Script中支持库的jsdoc变体不支持您正在寻找的层次结构文档，只支持一级函数。有一个相关的未解决错误报告，但没有来自Google的响应。

您仍然可以编写您的jsdoc标记，并在Google基础设施之外生成您的文档。查看如何预览google doc脚本中的jsdoc注释，以获取有关如何预览您的jsdoc注释的指针。您可以获取jsdoc3的输出并将其发布在网站上，以向您的社区提供文档。

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

1
如果您正在使用TypeScript，我们已经构建了一个旨在帮助您的包：

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

我们使用它来为我们的基于Typescript编写的OO库和客户端API生成自动完成。
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接