0

背景JavaScriptのドキュメント生成Cloud9 IDE

私はちょうどcloud9 IDEに小さなHTML5プロジェクトを終えました。私のプロジェクトはindex.htmlファイル、3つのJavaScriptファイル、およびカスタムstyles.cssファイルで構成されています。

私はHTMLとCSSを文書化できないことは知っていますが、私のプロジェクトの中核はJavaScriptですから、文書化したいと思います。

研究

このため、私はJSDocsDoccoDoxEsdocのようなJavaScriptのドキュメントジェネレータツールの使用方法で検索。私もその問題に関する記事を読んで(comparison between JavaScript documentation tools)、私もNaturaldocsを見ました。

問題は、ここでの主な問題は、(私の知る限り理解して)これらのツール(Naturaldocsを除く)すべてが私のファイルが既に持っている文書に基づいて、美しいHTMLや値下げのページを生成することです。彼らは私が加えたコメントを読んで、それに基づいてドキュメントを生成します。

これは私が探しているものではありません。

何が必要ですか?

私はあなたがその手間からあなたを節約定型コードとキーとpluggin文書の組み合わせドキュメント全体を、押しpluggins GhostdocAtomineerのコメント機能のようなものを探しています。

決勝ノート

私はnpmを使用して(Naturaldocs除く)以前のすべてのツールをインストールしました。おそらく私は何かを見逃していましたが、GhostdocとAtomineerがやるツールはありませんでした。これらのプラグギンは、cloud-ideが使用するACEエディタ(afaik)にはインストールできません。

TLは、DR

はCloud9 IDEでJavaScriptファイルを文書化する方法のいずれかを知っていますか?

答えて

1

リサーチの結果、残念ながらJavaScriptコードに基づいてドキュメントを自動的に生成するツールはないと結論づけました。手動ですべてを文書化し、HTMLページなどを生成するために多くの既存ツールを選択する必要があります。

私はJSDocを使用しました。そのドキュメントの標準は簡単にアクセスでき、比較的よく文書化されています。

これは、私が来たのと同じ背景から来ている誰かを助けてくれることを願っています。

がうまくいけば、誰かがそれを見て、それから何かを行います:


さらに、私はまた、公式フォーラムの機能要求を作成しました。

1

エースのプラグインはありませんが、http://smartcomments.github.io/のようなcliツールがありますので、クラウド9でも使用できます。

関連する問題