Flutter/Dart 内嵌文档注释的格式?
Flutter/Dart Formatting for in-line Documentation Comments?
Flutter/Dart 内联文档是否有额外的格式化选项?
我正在使用 Android Studio。我更喜欢留下详细的注释,这样我就不必花时间查看代码来弄清楚为什么使用特定的 class 或方法。在 C# 中,我使用三斜杠 (///) 添加内联文档。我知道 Dart 也使用三斜线,但与 C# 略有不同。例如,Dart 不支持 Summary、Para 和 Param 标签。
根据我的发现,Dart 使用以下内容:
当然,三斜杠 (///) 是基本的内联文档注释
/// My Documentation Comment
我发现您可以使用加号 (+) 或减号 (-) 来表示项目符号列表中的项目:
/// - Bullet List Item 1
/// + Bullet List Item 2
您也可以使用井号 (#) 来强调一行。
/// # This Line will be Emphasized
最后,它支持评论中换行的BR标签。
/// This is line 1
/// This will also appear on line 1
/// <br /> This will appear on line 2
除了这 4 个之外,在 Dart 中处理内联文档时是否还有其他格式化选项可以执行?
在评论中使用TODO。
TODO 将使其突出显示并易于访问
///TODO:something in comment
这适用于 android studio
Dartdoc uses Markdown,因此您可以在 Dartdoc 注释中使用最典型的 Markdown 格式。
Flutter/Dart 内联文档是否有额外的格式化选项?
我正在使用 Android Studio。我更喜欢留下详细的注释,这样我就不必花时间查看代码来弄清楚为什么使用特定的 class 或方法。在 C# 中,我使用三斜杠 (///) 添加内联文档。我知道 Dart 也使用三斜线,但与 C# 略有不同。例如,Dart 不支持 Summary、Para 和 Param 标签。
根据我的发现,Dart 使用以下内容:
当然,三斜杠 (///) 是基本的内联文档注释
/// My Documentation Comment
我发现您可以使用加号 (+) 或减号 (-) 来表示项目符号列表中的项目:
/// - Bullet List Item 1
/// + Bullet List Item 2
您也可以使用井号 (#) 来强调一行。
/// # This Line will be Emphasized
最后,它支持评论中换行的BR标签。
/// This is line 1
/// This will also appear on line 1
/// <br /> This will appear on line 2
除了这 4 个之外,在 Dart 中处理内联文档时是否还有其他格式化选项可以执行?
在评论中使用TODO。 TODO 将使其突出显示并易于访问
///TODO:something in comment
这适用于 android studio
Dartdoc uses Markdown,因此您可以在 Dartdoc 注释中使用最典型的 Markdown 格式。