アフターフィニッシュhand writing almost a thousand lines of documentation , 私は、二度とそれを決してしないと誓いました.それで、私は、私のためにこの退屈な仕事をするためにすべての最高のツールを見つけるために、探索に出ました.
確かに、これらのツールは、すでに存在する必要がありますか?npm install 何か、コマンドを実行し、正しいか?ではない.
私は、機能的なJavaScriptコードを文書化しようとしています.機能JavaScriptの上昇で、私はそれがとても複雑であることを驚くべきであるとわかります.
このようなドキュメントを作成したいだけです.

// how do I document you, little function?
const add = x => y => x + y

私はVSCODEのIntelliSenseのドキュメントを理解するために、私はまた、いずれかのマークダウンファイルやHTMLを生成したいと思います.

JSDOC 3

最初のスタートはJSDOCです.私は、彼らがこのスペースを導いていると思っています.しかし、ドキュメントに関するサイトのために、彼ら自身のドキュメンテーションは本当に恐ろしいです.私は適切にドキュメントをどのようにドキュメントに関する情報を見つけるadd 関数.
オープンな問題を見つけるSupport for curried functions 日付をチェックします.2016年10月.

わかりました.JSDOP

南

これこそまさに私が探しているものです.スクリーンショットはすばらしく見えます.あー.JSDOC 3このプロジェクトは2017年4月18日に更新された.
リッピング南

ドキドックス

これはしっかりしているようだ.最終更新日2018年2月19日.まだ長い時間が、1年未満.
だから私は彼らに手を差し伸べるHow to document curried functions? .

ラジオ沈黙
裂け目doxdox.

スレート

これは私のお気に入りのスクリーンショットです.大きなテーマと最近の活動.
でもどうやって使うの?一見して、サイトのドキュメントは包括的ですが、どうやってドキュメントを書くのですか?
それは私がMarkdownを作成するように見えます、そして、HTMLはそれから生成されます.どこでマークダウンを置くのですか?私はvagrant ちょうど医者のため?
これをバックバーナーに入れます.

HMドック

What: Generates simple markdown documentation from Hindley-Milner single line // comments and optional /* */ block comments in JavaScript code.

これは面白いようです.CurrentコードのためのMarkdownジェネレータ.
VSCodeはあまり理解していませんが、少なくともAPIドキュメントを書きます.
しかし、6つ星.まだそれは試してみましょう.私は既に問題を提出した.

佳作

ESDoc - jsdocと同様です.
YUIDoc - jsdocと同様です.
Autodoc - JavaScript関数の上にコメントを書く
React Styleguidist - リビングスタイルガイドによる孤立反応コンポーネント開発環境
Storybook - インタラクティブUIコンポーネントのテスト＆テスト:反応、ネイティブ、Vue、角度反応

では、次は何ですか？

正直に言うと、私はこれらの解決策のいずれにも満足していません、そして、私は私自身の解決を転がすことにこの近くについてです.
コードのドキュメントを生成するにはどのようなソリューションを使用しますか?どのようにあなたのために働いていますか?
私の記事は非常に機能的なJavaScript重いです、あなたがより多くを必要とするならば、ここで、または、さえずりの上で私に続いてください!
もっと記事