😀
Flutter(Dart） のコメントアウト
はじめに
Dart に おける コメントアウトで
- // シングルラインコメント
- /// ドキュメントコメント
- /* マルチラインコメント
の違いを 瞬時に回答できますか？？
私はなんとなく雰囲気で使い分けており、なぜそのコメントアウトの種類を使うのか回答できない状態でした。
しかし、一度学習を行うとコードの質と読みやすさが格段に上がりましたので 共有したいと思い記事にしました！
本記事はさっと読めるようにしてあるので、ぜひ一読してください！
対象者
Flutter 、Dart で開発を行っているすべてのエンジニア
Dartのコメントアウトの種類
シングルラインコメント
用途: 簡単な説明や注釈にかく。
ex)
- TODO: コメント や メモ
- シンプルな ロジックの説明
カジュアルにコメントを残すときに使いましょう！
ドキュメントコメント
用途: ドキュメントコメントは、クラスやメソッド、プロパティなどの詳細な説明を提供するために使用される。
これらのコメントは、IDEやドキュメント生成ツールによって認識され、APIドキュメントとして抽出される。
こちらのパッケージを使うとドキュメントの自動生成ができるみたいですね！
コードをドキュメント化することはベスト プラクティスの 1 つと考えられており、特に製品レベルのアプリを管理している場合は、コード ベース全体をドキュメント化することが非常に重要です。
詳しくはこちらの記事をご参照ください。
マルチラインコメント
用途: 複数行にわたるコメントやブロックコメント。
参考
Discussion