Question

Do we have any code documentation syntax and tool support for generating Code Documentation out of Dart Application Code, something similar to Doxygen for C/C++. I prefer to use Markdown styled syntax than doxygen-syntax.

Was it helpful?

Solution

The DartDoc tool (which uses markdown) creates API documentation (as found at api.dartlang.org )

This describes the api reference for using DartDoc in your own code

The Readme.txt here, shows how you can format your code comments to generate API doc

OTHER TIPS

///I am the beerclass
class BeerClass{
  ///this is a beer variable
  String beername;

  ///this is a beer method
  String get getBeer => "beer for the people";
}

Just go in the Darteditor: Tools->Generate Dartdoc. You get a new directory docs and you start index.html in your browser. Your class, variable and method have now documentation.

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top