 |
Post Ay5k9GGuYfwA1MCnr6 by [email protected] |
 |
More posts by [email protected] |
|
Post #Ay5eFSheeVGoaYHulc by [email protected] |
|
0 likes, 1 repeats |
|
|
|
Programmers - which of these commenting conventions do you personally prefer?1.… |
|
|
|
Post #Ay5eFSokE8wQwXbZom by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent Interesting question!I've always done function/method/class descript… |
|
|
|
Post #Ay5enQSDWKGnSXGK5g by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent For me it depends if you are intending the comment for someone editing t… |
|
|
|
Post #Ay5enSeLMD9sGix2Gm by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent though I prefer a language with docstrings |
|
|
|
Post #Ay5eorDPVaJAkO1Frs by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent Above especially on those instances I use a folding editor. |
|
|
|
Post #Ay5epH2fU9AEqbC2jY by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent Definitely above, and it's usually necessary anyway for IDEs to pick… |
|
|
|
Post #Ay5eq5DivJiUTMkZuK by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent Above the function to describe what it does/how to use it, inside the fu… |
|
|
|
Post #Ay5eqVEKDhe98lEQSG by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent ... but I'll sometimes explain in more detail within the function |
|
|
|
Post #Ay5eqVLPnLJlUkY5VQ by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@libbymiller @Edent this! A brief explanation above then more detail inside all… |
|
|
|
Post #Ay5hIsimfoFk0v8e0G by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent also, /* */ for anything like a docstring, and // for all other comments… |
|
|
|
Post #Ay5hKWXe6jwxnuiBns by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent … but of course having to comment a function is obvious code smell as … |
|
|
|
Post #Ay5hKf1iYol47UqJmq by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent As long as someone documents something somewhere, I'm good ;-) |
|
|
|
Post #Ay5hMoVQHwXu68lQ3M by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent function doWhatItSaysOnTheTin() {} |
|
|
|
Post #Ay5k9GGuYfwA1MCnr6 by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent Ideally you code cleanly enough that the comment is not necessary ;) |
|
|
|
Post #Ay5pb9Xvem4x2cHhKa by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent above, except python because it's got it's own special reasons f… |
|
|
|
Post #Ay5qwjUDKMA2XiOtyy by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@libbymiller @Edent The argument in favor of inside that was persuasive to me i… |
|
|
|
Post #Ay5vYPQ2mizB7sffWa by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent I prefer "whatever the established standard is in the language I… |
|
|
|
Post #Ay5veJNCB0B6729Ytk by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent @rubenerd when in rome.... |
|
|
|
Post #Ay61bNE9zP2CvFuRdI by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@otfrom @Edent strongly seconded, docstrings are magical!! Python style docstr… |
|
|
|
Post #Ay65TvzJGaO6EKfghs by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent Above is the Exec Summary for users of the fnInside is the Technical Int… |
|
|
|
Post #Ay685W1US2eUc8jsx6 by [email protected] |
|
0 likes, 2 repeats |
|
|
|
@Edent I always embedded that information inside the function or procedure. Th… |
|
|
|
Post #AyJ3XtChsvr5tvAubA by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@Edent above functions, but don't ask me about if, else if and else groups.… |
|
|
|
Post #AyKkjJ6mP5jicA3N9k by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@ottobackwards @Edent @rubenerd ... do what the Egyptians did. |
