XML documentation

Navigation
9

I develop a framework in PHP and would not like to comment on the code of the framework directly in the classes, for several reasons.

So I would like to know if there is an editor that reads the documentation from an XML or something similar, for example:

  • Repository.php - class used without documentation
  • Repository.php.xml - documented class or documentation information only.

In Visual Studio this functionality is used with scripts:

  • jquery.js - undocumented scripts
  • jquery.vsdoc.js - scripts with documentation
asked by anonymous 13.08.2014 / 02:44

1 answer

4

There are a few ways to generate php documentation, but most of these APIs generate documentation from your code analyzes. I'll leave some links here:

There is an issue in StackOverflow in English that may also have the answer to your question here >, but I believe that, at least at the moment, there is no third-party tool or plugin that does the documentation via XML (which, in my opinion, is a lot easier).

    
18.11.2014 / 12:46
What is the difference between @PostConstruct and the constructor? What is the difference between event and delegate?