I'm not sure this should be discussed here but...
Julian Scheid [EMAIL PROTECTED] writes:
Now the Classpath comments do sometimes contain stuff like
/**
* ... maintained by [EMAIL PROTECTED]
* ...
*/
and
/**
* ... for example,
* pre
* if (a
Nic Ferrier wrote:
I do agree that XML is the way forward (docbook might make a good
replacement for texinfo when it has widespread support like texinfo)
but the issue of in-source readable comments will need to be solved
before it is a really practical option.
It seems to boil down to
Nic Ferrier wrote:
But none of that is really important. The bottom line is: you will
never get all the authors of source code to write well-formed XHTML,
you're always going to miss something. That's why it sucks.
OK if this is the problem, let me put it that way:
If we _aim_ towards
I am not opposed to doing better markup of comments in my code. As I
write doc comments, I have been trying to make formatted lists
correctly, use lt; instead of , and other things; but I do not always
get it correct. Further, I have not tested my documentation work by
running it through any
Eric Blake [EMAIL PROTECTED] writes:
I agree with the sentiment that the final output is worth the reduced
readability in the source code, but I am willing to go with the majority
on this decision, whichever way it gets decided.
The tool will probably dictate the matter.
Brian
--
Brian
5 matches
Mail list logo
