Timeline for Generate a JavaDoc comment [closed]
Current License: CC BY-SA 3.0
20 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Dec 13, 2017 at 15:52 | history | closed | Riker Pavel Erik the Outgolfer caird coinheringaahing♦ Laikoni | Needs details or clarity | |
| Sep 16, 2011 at 20:14 | vote | accept | Keith Randall | ||
| Aug 13, 2011 at 21:31 | answer | added | Lowjacker | timeline score: 1 | |
| Jul 28, 2011 at 1:24 | answer | added | Hojung Youn | timeline score: 3 | |
| Jul 26, 2011 at 17:55 | history | tweeted | twitter.com/#!/StackCodeGolf/status/95915189186199553 | ||
| Jul 26, 2011 at 14:18 | answer | added | user unknown | timeline score: 0 | |
| Jul 26, 2011 at 14:01 | comment | added | Keith Randall | @Joey: no, the method will not be generic. But the return and argument types might be. | |
| Jul 26, 2011 at 14:00 | comment | added | Keith Randall | @Joey: there may be any number of spaces, including zero, between any alphanumeric token and any punctuation token. In other words, anything that would be legal java code (with the exception that I'm restricting all types to be space-free). | |
| Jul 26, 2011 at 9:05 | comment | added | Joey | Can the method be generic? And if so, does the generic type argument be included in the JavaDoc? | |
| Jul 26, 2011 at 9:04 | history | edited | Joey | CC BY-SA 3.0 | formatting |
| Jul 26, 2011 at 8:55 | comment | added | Joey | Are all blanks guaranteed to be only one space character or can there be more? I.e. void foo() throws A ,B. Will throws always be separated by a space from the )? Will there never be a space after the method name? | |
| Jul 26, 2011 at 8:12 | answer | added | Joey | timeline score: 2 | |
| Jul 26, 2011 at 7:57 | comment | added | Joey | JBernado: The return type is already in the method signature. Why mention it a second time? While Java is happy to duplicate visible information elsewhere this isn't such a case. | |
| Jul 26, 2011 at 4:31 | comment | added | user unknown | Can we assume all input to be valid? | |
| Jul 26, 2011 at 3:09 | comment | added | JBernardo | the @return tag for that input shouldn't be @return Integer $? | |
| Jul 26, 2011 at 2:52 | comment | added | Keith Randall | You may assume that all types will be space-free (but as you point out, they may have []<> characters in them). You may also assume that all blank spaces are composed of space characters only (i.e., no tabs). There may or may not be spaces surrounding (both before and after) a comma. | |
| Jul 26, 2011 at 2:30 | comment | added | user unknown | What's about arrays and generic types as param/return type? They introduce new opportunity for blanks. Do we assume all delimiters being blanks, or may they be tabs? After a comma - is there always a blank (or a tab)? | |
| Jul 26, 2011 at 2:11 | comment | added | Keith Randall | @Joey - the * you mention are optional in Javadoc comments - they are not needed for this question. | |
| Jul 26, 2011 at 2:01 | comment | added | Joey Adams | The javadoc comments on the Wikipedia page show leading ` * ` on the second to penultimate lines. Could you either change the example output to match it, or clarify that no leading ` * ` should be printed? | |
| Jul 26, 2011 at 1:40 | history | asked | Keith Randall | CC BY-SA 3.0 |