首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >在线文档注释的颤振/Dart格式?

在线文档注释的颤振/Dart格式?
EN

Stack Overflow用户
提问于 2021-11-22 14:34:30
回答 2查看 594关注 0票数 0

是否有额外的格式设置选项用于颤振/Dart在线文档?

我在用安卓工作室。我更喜欢留下详细的注释,这样我就不必花时间查看代码来找出为什么会使用特定的类或方法。在C#中,我使用三元斜杠(/) with添加内联文档。我知道Dart也使用三重斜杠,但与C#略有不同。例如,Dart不支持摘要、Para和Param标记。

根据我的发现,Dart使用了以下内容:

当然,三元斜杠(//)是一个基本的在线文档注释。

代码语言:javascript
复制
/// My Documentation Comment

我发现您可以使用加号(+)或减号(-)来表示项目列表中的项目:

代码语言:javascript
复制
/// - Bullet List Item 1
/// + Bullet List Item 2

您也可以使用Hash (#)来强调一行。

代码语言:javascript
复制
/// # This Line will be Emphasized

最后,它支持注释中新行的BR标记。

代码语言:javascript
复制
/// This is line 1 
/// This will also appear on line 1
/// <br /> This will appear on line 2

除了这4之外,在使用Dart中的内联文档时,还有其他格式选项可以执行吗?

EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2021-11-22 17:49:27

达特多克使用Markdown,所以您可以在Dartdoc注释中使用最典型的Markdown格式。

票数 1
EN

Stack Overflow用户

发布于 2021-11-22 14:41:42

在注释中使用TODOTODO将使其突出显示并可访问。

代码语言:javascript
复制
///TODO:something in comment

这适用于android工作室。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/70067492

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档