web-dev-qa-db-ja.com

コメント付きのJavaScriptファイルを文書化する方法に規則はありますか?関数のシグネチャ、例など

JavaにはJavadocがあり、Pythonにはdocstringがあります。JavaScriptに類似したものはありますか?

47
Lyd

最も一般的に使用されるのはJsDoc( https://jsdoc.app/ )です。

これは、ソースからドキュメントを生成するツールでもあり、JsDocスタイルでコメントされています: https://github.com/jsdoc3/jsdoc

42
Tibos