Timeline for Standardized code documentation format, where is it? [closed]
Current License: CC BY-SA 4.0
18 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Dec 18, 2018 at 17:31 | history | closed |
gnat Thomas Owens♦ |
Needs more focus | |
| S Dec 18, 2018 at 16:19 | history | suggested | albert | CC BY-SA 4.0 |
doxygen documentation is at another place
|
| Dec 17, 2018 at 16:45 | review | Close votes | |||
| Dec 18, 2018 at 17:35 | |||||
| Dec 17, 2018 at 13:35 | review | Suggested edits | |||
| S Dec 18, 2018 at 16:19 | |||||
| May 11, 2012 at 3:42 | vote | accept | dukeofgaming | ||
| May 8, 2012 at 7:48 | comment | added | gnat | doc format / style that would fit both Java and x86 assembly languages, would be damaging for programmer's productivity | |
| May 8, 2012 at 6:58 | comment | added | user1249 | The reason JavaDoc is popular is because Sun 1) set a very good example with the runtime javadoc and 2) made it available to everyone in the JDK. For a given community to accept anything you need something similar for that community. | |
| May 8, 2012 at 6:54 | comment | added | Caleb | @dukeofgaming I was mostly joking, but it does seem unlikely that a single way to encode documentation will ever emerge. Different programmers have different needs, and both programmers and tool vendors are always looking for better ways to do things. Doxygen is a great example of a system that's widely used and a sort of standard, but as you point out there are others as well. The reason there are so many others is that programmers don't form a homogeneous group -- we all have different preferences and requirements. Vive la difference! | |
| May 8, 2012 at 6:46 | answer | added | Randall Cook | timeline score: 3 | |
| May 8, 2012 at 6:42 | comment | added | Randall Cook | @Caleb, sometimes even one programmer can't agree on how to format his/her code. :) | |
| May 8, 2012 at 4:57 | comment | added | user53141 | Doxygen is about as much of a standardization as you're going to get. It's hard enough to standardize a single language must less something that applies to all languages! | |
| May 8, 2012 at 4:57 | comment | added | AProgrammer | Mandatory XKCD reference. | |
| May 8, 2012 at 3:13 | comment | added | Pubby | What does standardization have to do with being usable across different languages? | |
| May 8, 2012 at 2:27 | comment | added | dukeofgaming | @Caleb I'm mostly talking about a standard to have the same (or similar) input for documentation generation tools, where there would be common ground for code metadata... but why not?, there are code standards. | |
| May 8, 2012 at 2:22 | comment | added | Caleb | Three programmers using the same language and the same tools on the same platform generally won't agree about how to format their code. You want them to agree on how to write documentation? | |
| May 8, 2012 at 2:08 | history | edited | dukeofgaming | CC BY-SA 3.0 |
added 4 characters in body
|
| May 8, 2012 at 1:56 | comment | added | Reactgular | what's documentation? | |
| May 8, 2012 at 1:51 | history | asked | dukeofgaming | CC BY-SA 3.0 |