Содержательные doc-комментарии
// 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> {...}
This slide and its sub-slides should take about 85 minutes.
-
Doc-комментарии — самая распространённая форма документации, с которой работают разработчики.
-
Хорошие doc-комментарии дают информацию, которую не могут дать код, имена и типы, не повторяя очевидного.