1

Dart has a dartdoc documentation syntax with {@template} and {@macro}. I was wondering if there was a naming convention for it. In the doc, they only give the {@template template_name} example which is in snake_case.

For now, I'm naming my templates like this:

{@template project_name.class_name.method_name} (snake_case separated with .).

For example for the project project_name:

File class_name.dart

/// {@template project_name.class_name}
/// ...
/// {@endtemplate}
class ClassName {
  /// {@template project_name.class_name.method_name}
  /// ...
  /// {@endtemplate}
  void methodName() {}
}

I was wondering if there was already some conventions for those template names?

Valentin Vignal
  • 6,151
  • 2
  • 33
  • 73

0 Answers0