我只是在评论我的应用程序,因为我发现你可以使用不同的评论。我很好奇,如果有一些评论规则,这或有什么与flutter它自己的自动评论?我的选择去的///之一,因为颜色是不同的,所以它是更好地看到我的评论和Flutter做了什么。这让我想知道为什么有两种不同的方式来评论
///
// <-- This is a way /// <-- This is a way
先谢了
pbwdgjma1#
在Flutter中,//用于创建单行注解,Dart编译器会忽略它。///用于创建文档注解,该注解可用于使用dartdoc工具为代码生成文档。Dart编译器也会忽略此类注解,但它可用于为阅读代码的开发人员提供有关类、函数或变量的其他信息。示例:
//
dartdoc
/// This is a documentation comment for a function void myFunction() { // this is a single-line comment }
当您使用dartdoc工具时,它将从代码中提取注解并生成HTML格式的文档。除此之外,请参阅有关dartdocguides-documenting-dart-libraries的官方文档。有关用法和示例,请参阅guides-dartdoc
dy2hfwbg2#
Dart支持三种注解:
// Inline comments /* Blocks of comments. It's not convention to use block comments in Dart. */ /// Documentation /// /// This is what you should use to document your classes.
也可以给予你一个很好的提示
// TODO: some words
s8vozzvw3#
根据“高效 dart ”//用于单行注解,就像函数内部的注解一样///用于多行(尽管也支持单行)文档注解,就像函数定义上面的注解一样。
bqucvtff4#
//用于单行注解,就像函数内部的注解一样///是用于文档注解的多行代码,就像上面的函数定义一样。
4条答案
按热度按时间pbwdgjma1#
在Flutter中,
//
用于创建单行注解,Dart编译器会忽略它。///
用于创建文档注解,该注解可用于使用dartdoc
工具为代码生成文档。Dart编译器也会忽略此类注解,但它可用于为阅读代码的开发人员提供有关类、函数或变量的其他信息。示例:
当您使用
dartdoc
工具时,它将从代码中提取注解并生成HTML格式的文档。除此之外,请参阅有关
dartdoc
guides-documenting-dart-libraries的官方文档。有关用法和示例,请参阅guides-dartdocdy2hfwbg2#
Dart支持三种注解:
也可以给予你一个很好的提示
s8vozzvw3#
根据“高效 dart ”
//
用于单行注解,就像函数内部的注解一样///
用于多行(尽管也支持单行)文档注解,就像函数定义上面的注解一样。bqucvtff4#
//
用于单行注解,就像函数内部的注解一样///
是用于文档注解的多行代码,就像上面的函数定义一样。