CODEWITHSUNDEEP
language-agnosticasciidoc
Jason000
Jason000

Reputation: 199

Can AsciiDocs be used like JavaDoc?

I've been using AsciiDocs to write all my documentation, and i was wondering if i could take it a step further and generate the html from my source code, like how JavaDoc does with Java source code.

For example, JavaDoc allows the developer to leave in-line comments that will later be used to generate the html documentation. Is this possible with AsciiDocs? Or do I just need to write the documentation separately?

Upvotes: 0

Views: 418

Answers (1)

Joni
Joni

Reputation: 111259

Javadoc is somewhat modular and extensible: you can use a custom formatting syntax in javadoc comments if you generate the documentation with a custom "doclet".

For AsciiDoc, such a doclet already exists: https://github.com/asciidoctor/asciidoclet

Javadoc is specific to Java, if you use other programming languages there are other tools. Doxygen was created specially for C and C++ but it supports several programming languages and comment styles. For Python, there is pydoc. Whether there's a way to make these support AsciiDoc syntax, you'll have to investigate on your own.

Upvotes: 2

Related Questions