Search code examples
flutterdartflutter-dependenciesflutter-pluginflutter-packages

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!


Solution

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