Programming | JSDoc

JSDoc Homepage

JSDoc is a tool that parses inline documentation in JavaScript source files, and produces an HTML summary.

JavaScript版のJavaDoc。@constructorタグと@privateタグが追加されている。

JavaScriptはメソッドのオーバーロードに対応しておらず、メソッドの引数が定義されていても、呼び出し時に渡さなければ、undefinedとなるだけで呼び出しエラーということにはならない。
なので、内部で引数判定を行っているようなメソッドは、引数についてしっかりドキュメント化しておく必要がある。