Google Apps腳本自動生成的文檔請參閱和漂白

Question

當爲Google apps腳本庫使用自動生成的文檔時，可以使用Google代碼示例的類？我試過在pre標籤中包含它： <pre class="prettyprint">

但似乎在代中被剝離出來。

還有一種方法可以使用@see命令來引用代碼文檔中的函數或外部資源嗎？

Answer 1

google-apps-script支持的gsdoc標籤有很多限制，並且您只描述了其中兩個限制 - 不支持html元素屬性和有限的doc標籤。我在How to preview jsdoc comments in google doc scripts中描述了一些其他問題。

也有開放性問題：

• Preview jsDoc documentation from within the script editor
• Make it easier to show examples by supporting @example in Libraries
• Support Object Oriented Interfaces with documentation for Libraries

你可以添加一個新的問題，爲您的特別關注。 @see標記尤其奇怪，因爲它出現在基本服務文檔中，所以標記只適用於Google，或者用html代替它。

一種選擇是在另一個平臺或託管服務上構建和託管文檔。對於一些着名的國庫，例如2D Array Library就是這樣做的。然後，您可以使用jsdoc生成文檔，並使用整個標籤集的豐富性。