JavaScript自編檔案代碼哪裏有API Docs工具？

這兩個概念似乎違反直覺。爭論的一個方面是看到評論對可讀性造成的危害，以及違反DRY（如果評論甚至保持最新）。但是，拋開硬幣，有必要爲您的代碼提供良好的API文檔，以便其他人可以使用您的庫。JavaScript自編檔案代碼哪裏有API Docs工具？

我已經看到，被設計用於產生API文檔每件工具（JSDoc，PDOC等）使用的空間極端量，以提供該文檔。我需要提供API文檔，我不需要的是讓我的LOC的一半進行特殊格式的註釋，以便JSDoc可以讀取它。

我目前正在考慮像Jekyll基本降價的工具，把這個文件在/ doc文件夾，完全從我的代碼中刪除。是否有其他人找到了解決這個問題的方法？

2011-03-17 Drew

如果使用在製作的時候壓縮劇本，你真的不必擔心你的代碼中多餘的線條。 – epascarello 2011-03-17 18:03:11

完全確認。如果你想提供高質量的文檔，應該保留源代碼。在製作中使用壓縮文件時（無論如何你都應該這樣做），評論根本不重要。 – Daff 2011-03-17 18:09:17

不擔心生產文件，壓縮機將刪除它。我希望可讀文件不是特別格式化的75％，所以有些工具可以讀取它。 – Drew 2011-03-21 18:33:34

Sphinx是許多語言的文檔工具，而是假設您將主要寫你的文檔中的外部文件。它仍然有一個autodoc擴展名，它允許您從代碼中的註釋中提取文檔。

我個人覺得更方便的API文檔只是附近的代碼，因爲它可以幫助我保持它是最新的。此外，使用該代碼的其他人將能夠在需要時獲得文檔，而無需瀏覽外部文件。坦率地說，在看到大量代碼是評論時，並沒有看到任何錯誤：編輯通常會對評論的顏色進行不同的評論，並允許您在需要時忽略它們。

2011-03-17 18:06:33 Andrea

就使用外部文件而言，這看起來很酷。我想堅持降低交叉工具的抱怨，因爲很多人都在切換到降價。這可以解析JavaScript文件嗎？ – Drew 2011-03-21 18:32:48

我沒有嘗試過，但autodoc也應該使用Javascript文件。 – Andrea 2011-03-21 19:46:24

回答