记录Javascript代码 [英] Documenting Javascript code
问题描述
我正在开发一个有点复杂的网站，所以我开始记录我的代码。
I'm developing a site which is growing a bit complex and so I started documenting my code.
对于PHP我已经使用了PHPDocumentor;在任何情况下，似乎任何其他工具（如Doxygen）都会接受相同的标签。
For PHP I have used PHPDocumentor; in any case it seems that any other tool (such as Doxygen) would accept the same tags.
现在我要记录JS端。我至少看到JSDoc和ScriptDoc（可能还有其他）存在，他们接受不同的标签，所以我应该做出选择。用于记录Javascript代码的标准（如果有）是什么？
Now I want to document the JS side. I see at least JSDoc and ScriptDoc (and probably others) exist, and they accept different tags, so I should make a choice. What is the standard (if any) for documenting Javascript code?
而且，它们如何使用？看来ScriptDoc是集成在Aptana工作室，所以有没有IDE可以使用它？
And moreover, how are they used? It seems ScriptDoc is integrated in Aptana studio, so is there any way to use it without the IDE?
推荐答案
一个记录JavaScript代码的标准方式。
There is no really a "standard" way of documenting JavaScript code.
JSDoc项目不再有效，您应该查看 JsDoc Toolkit 。
The JSDoc project is no longer active, you should give a look to JsDoc Toolkit.
还有其他很好的选择，以下项目很漂亮好：
There are other good alternatives, the following projects are pretty good:
- YUIDoc
- PDoc
关于 ScriptDoc ，我认为它专注于在Aptana上启用 Code Assist 功能，而不是生成文档文件。
About ScriptDoc, I think it's focused on enabling Code Assist features on Aptana, rather than to generate documentation files.
这篇关于记录Javascript代码的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
