面向Kotlin与Java开发者的Dart快速入门（十三）注释

你的名字 2023-07-11 05:47 16阅读 0赞

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZpdGF2aXZh_size_16_color_FFFFFF_t_70]  
Dart的注释用法与Java大体相同。

# 单行注释 #

--------------------

final hoge = 0;    // 到行末都是注释内容

# 多行注释 #

--------------------

与Java一样`/**/`

void main() { 
      /* * This is a lot of work. Consider raising chickens. Llama larry = Llama(); larry.feed(); larry.exercise(); larry.clean(); */
    }

# 文档注释 #

--------------------

使用[dartdoc][]可以生成HTML的API文档。  
dartdoc会在IDE智能提示时发挥作用，所以对外暴露的API建议添加文档注释。

Java的文档注释使用`/**`开头，Dart中同样支持。另外，`///`的连续多行注释也可以作为文档注释。

/// A domesticated South American camelid (Lama glama).
    ///
    /// Andean cultures have used llamas as meat and pack
    /// animals since pre-Hispanic times.
    class Llama { 
      String name;
    
      /// Feeds your llama [Food].
      ///
      /// The typical llama eats one bale of hay per week.
      void feed(Food food) { 
        // ...
      }
    
      /// Exercises your llama with an [activity] for
      /// [timeLimit] minutes.
      void exercise(Activity activity, int timeLimit) { 
        // ...
      }
    }

像Java一样，文档注释中`[]`会成为一个链接，例如`[Food]`可以链接到Food类的定义位置。

--------------------

# 返回首页：[Dart入门教程][Dart] #

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZpdGF2aXZh_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200626132353753.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZpdGF2aXZh,size_16,color_FFFFFF,t_70
[dartdoc]: https://github.com/dart-lang/dartdoc#dartdoc
[Dart]: https://blog.csdn.net/vitaviva/article/details/104587313