意味のあるドキュメントコメント

// Copyright 2025 Google LLC
// SPDX-License-Identifier: Apache-2.0

/// クライアント向け API // ❌ 詳細が不足しています
pub mod client {}

/// A から B への関数 // ❌ 冗長です
fn a_to_b(a: A) -> B {...}
 
/// データベースに接続します。 // ❌ 詳細が不足しています
fn connect() -> Result<(), Error> {...}

  • ドキュメントコメントは、開発者が最もよく接するドキュメント形式です。

  • 優れたドキュメントコメントは、明らかな情報を言い換えることなく、 コード、名前、型だけでは伝えられない情報を提供します。