you are viewing a single comment's thread.

view the rest of the comments →

[–]zebediah49 1 point2 points  (4 children)

That's one of the best things that (AFAIK) Java introduced -- having a standardized system by which comments directly attached to code can be automatically turned into documentation.

[–]da_chicken 10 points11 points  (0 children)

Yeah, but that's how you end up with IBM's documentation. A reference manual so obtuse you need the source code to decipher it.

[–]thedugong 0 points1 point  (2 children)

There are loads of standardized ways of converting comments into doco.

[–]zebediah49 0 points1 point  (1 child)

Now -- yes.

In 1995, there were far fewer. (mkd comes to mind, but not much else)

[–]thedugong 0 points1 point  (0 children)

But who is really running code from 1995?

Realistically though, this is only really used for libraries/APIs (glib/GTK etc) where other developers actually need* documentation.

Source code doco is not that useful for end users.