body method

@override String body(String baseName, String className)

Defines the actual body code. path is passed relative to lib, baseName is the filename, and className is the filename converted to Pascal case.

実際の本体コードを定義します。pathにlibからの相対パス、baseNameにファイル名が渡され、classNameにファイル名をパスカルケースに変換した値が渡されます。

Implementation

@override
String body(String baseName, String className) {
  return r"""
## DartDocの書き方

- 基本的にはDartのドキュメントと同じ書き方。
  - `///`を用いてドキュメントを記載
- 公開されているクラスやメソッド、プロパティや変数に対してすべて記載
  - Overrideされたメソッドやプロパティは記載しなくてもOK。
- 英語のドキュメントの下に必ず日本語のドキュメントも合わせて記載
  - 利用例のコードを書く場合は日本語の下に記載。
  - 例：
  ```dart
  /// Test page for DartDoc.
  ///
  /// DartDoc用のテストページ。
  ///
  /// ```dart
  /// TestPage();
  /// ```
  class TestPage extends StatelessWidget {
      /// Test page for DartDoc.
      ///
      /// DartDoc用のテストページ。
      const TestPage({super.key});

      @override
      Widget build(BuildContext context) {
          return const Placeholder();
      }
  }
  ```
""";
}