背景JavaScriptのドキュメント生成Cloud9 IDE
私はちょうどcloud9 IDEに小さなHTML5プロジェクトを終えました。私のプロジェクトはindex.html
ファイル、3つのJavaScriptファイル、およびカスタムstyles.css
ファイルで構成されています。
私はHTMLとCSSを文書化できないことは知っていますが、私のプロジェクトの中核はJavaScriptですから、文書化したいと思います。
研究
このため、私はJSDocs、Docco、DoxとEsdocのようなJavaScriptのドキュメントジェネレータツールの使用方法で検索。私もその問題に関する記事を読んで(comparison between JavaScript documentation tools)、私もNaturaldocsを見ました。
問題は、ここでの主な問題は、(私の知る限り理解して)これらのツール(Naturaldocsを除く)すべてが私のファイルが既に持っている文書に基づいて、美しいHTMLや値下げのページを生成することです。彼らは私が加えたコメントを読んで、それに基づいてドキュメントを生成します。
これは私が探しているものではありません。
何が必要ですか?
私はあなたがその手間からあなたを節約定型コードとキーとpluggin文書の組み合わせドキュメント全体を、押しpluggins GhostdocとAtomineerのコメント機能のようなものを探しています。
決勝ノート
私はnpm
を使用して(Naturaldocs除く)以前のすべてのツールをインストールしました。おそらく私は何かを見逃していましたが、GhostdocとAtomineerがやるツールはありませんでした。これらのプラグギンは、cloud-ideが使用するACEエディタ(afaik)にはインストールできません。
TLは、DR
はCloud9 IDEでJavaScriptファイルを文書化する方法のいずれかを知っていますか?