在一个类内部的方法编写jsdoc文档(Writing jsdoc documentation on

2019-07-19 23:36发布

我写在谷歌Apps脚本一些图书馆,我试图记录他们。 我已经写在下面的格式一些类,并在类中的方法的注释不会在文档中显示:

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

   this.myMethod=myMethod;
   ....

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

   function myMethod(){
     ...
   }

}

我如何能做到这一点任何想法?

Answer 1:

这个问题可能是重复...... 这个答案当然是 。

支载在谷歌Apps脚本库的jsdoc变异并不在你正在寻找的水平支持文档,只有第一级别的功能。 有一个相关的开放bug报告这一点,但没有从谷歌回应。

您仍然可以写你的jsdoc标签,并产生谷歌的基础设施之外的文档。 看看如何预览在谷歌文档的脚本jsdoc意见 ,了解如何预览jsdoc评论一些指点。 你可以采取的输出jsdoc3并发布在网站上提供您的文档到你的社区。

其他有关/可能重复的帖子:

  • 在创建一个谷歌的命名空间类组织的Apps脚本库
  • 谷歌Apps脚本自动生成的文档库


文章来源: Writing jsdoc documentation on methods inside a class