Serviceを読んで理解し、同意したものとみなします。スタック・オーバーフローはプログラマーとプログラミングに熱心な人のためのQ&Aサイトです。612件1Vue.jsで書いたソースにコメントを残すための、おすすめのフォーマットを教えてください。できればそのフォーマットに従って、実際にコメントされているソースを教えていただけると嬉しいです。ちなみにjQueryで書かれたプロジェクトにはJSDocが使われているイメージです。Vue.jsでJSDocが使われているプロジェクトはあまり見ない(そもそもフォーマットに従ってコメントされているのソースをあまり見ない)ため、判断できずに困っています。票1JSDocだと、ヒント表示やコード補完がエディタで出来るそうです。JavaScriptでJSDocコメントを書くメリットとは【Javascript】JSDocコメントの書き方、メリット上記で出来ないとなっていたエディタ用でもエクステンションが充実しているようです。上記から抜き出すと以下のようになります。全てのファイル、クラス、メソッド、プロパティにJSDocコメントが、適切なタグとデータ型を伴って記されるべきです。名前から明白に判断できる場合を除き、プロパティ、メソッド、メソッドの引数、メソッドの戻り値を説明する文章が含まれているべきです。良さそうな根拠を探してみました。古い記事ですが、考え方として。JavaScriptのコメントは不要か?そして何時ものMicrosoftとは言えますが、JavaScriptを改良してTypeScriptを作り、勢力を拡大しているように、JSDocを改良してTSDocを作っていて、普及させることができるかもしれません。ツールのサポートを組み込みで提供します。サポートの大幅な改善も予定しています。Microsoft/tsdocTSDocは、TypeScriptソースファイルで使用されているdocコメントを標準化するための提案です。残念ながら、JSDocの文法は厳密には指定されていませんが、特定の実装の振る舞いから推測されます。標準のJSDocタグの大部分は、単純なJavaScriptに型注釈を提供することに夢中になっています。これは、TypeScriptなどの強く型付けされた言語にとっては無関係な懸念です。TSDocはこれらの制限に対処しながら、より洗練された一連の目標にも取り組みます。倍近く(正確には1.78倍)集めているのがこれです。TypeStrong/typedocTypeScriptプロジェクト用のドキュメンテーションジェネレータ。自動生成とあるので、楽と言えば楽ですか。JavaDocスタイルのようですが。codeTypeDocはTypeScriptコンパイラを実行し、生成されたコンパイラシンボルから型情報を抽出します。したがって、コメント内に追加のメタデータを含める必要はありません。クラス、列挙型、プロパティ型などのTypeScript固有の要素やアクセス修飾子は自動的に検出されます。ドキュメントジェネレータは現在、次のjavadocタグを理解しています。JSDocもツールやスタイルガイドを充実させています。個の銅バッジ外部サイトへのリンクを含む回答をする場合でも、リンク先の内容の要約を回答に含めるようにしてください。リンクが切れたとしても回答の質を保つことができます。詳しくは「外部へのリンクしかない回答にはどう対応するべき?」をご参照ください。kunifさんはいつも有益なリンク先を見つけてきてくださっていて削除対象にするには惜しいので、是非一手間加えて頂けるとありがたいです。6:34JSDocの使い方はわかっています。質問したいのは、JSDocがVue.jsで書いたソースに最適かどうかどうかです。違う場合、JSDoc以外の最適なフォーマットを教えていただきたいです。JSDocが適している場合は、実装例を教えていただきたいです。Anguler.jsとReact.jsの実装例を示してくださっていますが、Vue.jsでJSDocが使われている例を教えていただきたいです。22:36最適を考えて着手が遅れるよりも、そこそこ評価できそうなものがあれば始めてしまうのが良いと思うのですが。|回答スタック・オーバーフローに参加してくれて、ありがとうございます!質問の回答を共有してください。回答を説明し、自分の検討結果も共有してください。意見を述べること(意見を述べるなら、参照リソース、自分の経験で意見をサポートしてください)さらにサポートが必要な場合このヘルプを参考してください。“回答を投稿”をクリックすることで利用規約、プライバシーポリシー、及びクッキーポリシーに同意したものとみなされます。タグが付いた他の質問を参照するか、自分で質問をする。Serverを起動させても急に反映されなくなりました。質問のフィードこのRSSフィードを購読するには、このURLをコピーしてRSSリーダーに貼り付けてください。