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,

enter image description here

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) {


Answered By – MaNDOOoo

Answer Checked By – Candace Johnson (FlutterFixes Volunteer)

Leave a Reply

Your email address will not be published. Required fields are marked *