Open2
（Kotlin）三種類のコメントの使い分け方（"//", "/* */", "/** */"）
ふじしろkotlinの３種類のコメントについて、自分の中で言語化できていなかったので調べたメモ
公式の記載
Just like most modern languages, Kotlin supports single-line (or end-of-line) and multi-line (block) comments.
以下の２種のコメントをサポートしている
- 単一行コメント（single-line, end-of-line）
- 複数行コメント（multi-line, block）
See Documenting Kotlin Code for information on the documentation comment syntax.
また、構文の異なるドキュメントコメントが別で存在する（KDoc）
これらの書き方から、基本のコメントは以下の２つで、
- 単一行コメント（
// ...） - ブロックコメント（
/* ... */）
KDocでドキュメント化したいものについて、ドキュメントコメント（/** ... */）を使うのだと理解した。
ふじしろベストプラクティスについて相談してみた。
ベストプラクティス整理
シングルラインコメント (// comment):
- 特定の行やコードの断片に対する簡潔な説明や、その行が何をするのかを示すのに使用する
- コードの読み手に対して、なぜそのコードが存在するのか、またはその行が特定の動作をする理由を簡単に説明する
マルチラインコメント (/* comment */):
- 長い説明や複数行にわたるコメントが必要な場合に使用する
- 複雑なアルゴリズムや、なぜそのコードブロックが必要か、どのような仕組みで動作するかなど、より詳細な情報を提供するのに役立つ
KDocコメント (/** comment */):
- APIやライブラリの公開インターフェースのドキュメンテーションに使用する。
- 関数の引数、戻り値、例外、使用例など、その要素を使用する他の開発者にとって重要な情報を提供する。これにより、コードの再利用性が向上し、他の開発者がコードの動作を理解しやすくなる。