Skip to main content
Post Closed as "Needs more focus" by gnat, Thomas Owens

I'm currently looking into API documentation generation tools and I noticed that apparently there are no efforts going on in standardization.

Javadoc style is kind of an ubiquitous convention... it is used for Java (duh), PHP (PHPDocumentor, Doxygendoxygen, Stubbles), C/C++ (Doxygendoxygen again)... and there is even IDE support for it even in other languages that are not java.

Even NaturalDocs which has a completely different syntax for documentation has some compatibility for it.

So my question is: are there any efforts going on in standardizing in-code documentation syntax?, which can in turn be used for documentation generators or language metadata across different languages?.

I'm currently looking into API documentation generation tools and I noticed that apparently there are no efforts going on in standardization.

Javadoc style is kind of an ubiquitous convention... it is used for Java (duh), PHP (PHPDocumentor, Doxygen, Stubbles), C/C++ (Doxygen again)... and there is even IDE support for it even in other languages that are not java.

Even NaturalDocs which has a completely different syntax for documentation has some compatibility for it.

So my question is: are there any efforts going on in standardizing in-code documentation syntax?, which can in turn be used for documentation generators or language metadata across different languages?.

I'm currently looking into API documentation generation tools and I noticed that apparently there are no efforts going on in standardization.

Javadoc style is kind of an ubiquitous convention... it is used for Java (duh), PHP (PHPDocumentor, doxygen, Stubbles), C/C++ (doxygen again)... and there is even IDE support for it even in other languages that are not java.

Even NaturalDocs which has a completely different syntax for documentation has some compatibility for it.

So my question is: are there any efforts going on in standardizing in-code documentation syntax?, which can in turn be used for documentation generators or language metadata across different languages?.

added 4 characters in body
Source Link
dukeofgaming
  • 14k
  • 6
  • 51
  • 77

I'm currently looking into API documentation generation tools and I noticed that apparently there are no efforts going on in standardization.

Javadoc style is kind of an ubiquitous convention... it is used for Java (duh), PHP (PHPDocumentor, Doxygen, Stubbles), C/C++ (Doxygen again)... and there is even IDE support for it even in other languages that are not java.

Even NaturalDocs which has a completely different syntax for documentation has some compatibility for it.

So my question is: are there any efforts going on in standardizing in-code documentation syntax?, which can in turn be used for documentation generators or language metadata across different languages?.

I'm currently looking into documentation generation tools and I noticed that apparently there are no efforts going on in standardization.

Javadoc style is kind of an ubiquitous convention... it is used for Java (duh), PHP (PHPDocumentor, Doxygen, Stubbles), C/C++ (Doxygen again)... and there is even IDE support for it even in other languages that are not java.

Even NaturalDocs which has a completely different syntax for documentation has some compatibility for it.

So my question is: are there any efforts going on in standardizing in-code documentation syntax?, which can in turn be used for documentation generators or language metadata across different languages?.

I'm currently looking into API documentation generation tools and I noticed that apparently there are no efforts going on in standardization.

Javadoc style is kind of an ubiquitous convention... it is used for Java (duh), PHP (PHPDocumentor, Doxygen, Stubbles), C/C++ (Doxygen again)... and there is even IDE support for it even in other languages that are not java.

Even NaturalDocs which has a completely different syntax for documentation has some compatibility for it.

So my question is: are there any efforts going on in standardizing in-code documentation syntax?, which can in turn be used for documentation generators or language metadata across different languages?.

Source Link
dukeofgaming
  • 14k
  • 6
  • 51
  • 77

Standardized code documentation format, where is it?

I'm currently looking into documentation generation tools and I noticed that apparently there are no efforts going on in standardization.

Javadoc style is kind of an ubiquitous convention... it is used for Java (duh), PHP (PHPDocumentor, Doxygen, Stubbles), C/C++ (Doxygen again)... and there is even IDE support for it even in other languages that are not java.

Even NaturalDocs which has a completely different syntax for documentation has some compatibility for it.

So my question is: are there any efforts going on in standardizing in-code documentation syntax?, which can in turn be used for documentation generators or language metadata across different languages?.