0

I am looking for documentation generation tools that only interpret the comment blocks when generating code documentation. It means that, to some extent, the tool does not depend on the programming language even if I need to declare everything.

One example is YUIDoc that parse "comment blocks, not source code". But the project seems lost support in it github page.

The output could be in any format (HTML, XML, JSON, etc ), but I would prefer a tool that produces an output with more semantically readable structure (e.g. XML, JSON ).

  • And what do you use that information for? – Thomas Weller Jun 19 at 20:51
  • 1
    Extract some metrics and relational information about the code in software I'm writing. Maybe I could do it with other tools, but I want to do some operations from the information given by the programmer in comments. – Erme Schultz Jun 19 at 21:00
  • And I'm not searching for any specific information extraction by now. The only tool I know that met my requirements is YUIDoc. Maybe other tools could provide syntax, tags, and information that I am not expecting. – Erme Schultz Jun 19 at 21:11
  • Ok, thanks. I was just considering that you have an XY-issue, where you think analyzing comments would be a solution for a totally diffferent problem. Technically, I think such a tool should be possible, especially if you're willing to configure much. Yet, I don't know any out-of-the-box tool. – Thomas Weller Jun 22 at 6:39
  • Thank you, Thomas. – Erme Schultz Jun 22 at 11:23

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Browse other questions tagged or ask your own question.