ドキュメントコメントのスラッシュ

ドキュメントコメントには///を使用することを推奨します。

このルールはDart 2.0から利用可能です。

ルールセット：推奨、Flutter

このルールにはクイックフィックスがあります。

Effective Dartより

推奨：ドキュメントコメントには///を使用します。

Dartは2つのドキュメントコメント構文（///と/**）をサポートしていますが、ドキュメントコメントには///を使用することを推奨します。

良い例

/// Parses a set of option strings. For each option:
///
/// * If it is `null`, then it is ignored.
/// * If it is a string, then [validate] is called on it.
/// * If it is any other type, it is *not* validated.
void parse(List options) {
  // ...
}

ドキュメントコメント内では、フォーマットにMarkdownを使用できます。

slash_for_doc_commentsルールを有効にするには、analysis_options.yamlファイルのlinter > rulesセクションにslash_for_doc_commentsを追加します。

linter:
  rules:
    - slash_for_doc_comments

特に記載がない限り、このサイトのドキュメントはDart 3.5.3を反映しています。最終更新日：2024年7月3日。 ソースコードを見る または 問題を報告する。