简体   繁体   中英

How to show description for widget & it's parameters in flutter?

I'm developing a flutter package wherein I want to add docs for widget's parameters like this,

在此处输入图像描述

I'm referring to the description of the widget and it's parameters!

You can comment using the /// . For more information, reference the Effective Dart: Documentation#doc-comments .

/// This function is ~~~
///
/// The [num] must be non-null ~~
void simpleFunction(int num) {

}

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM