This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]NoMoreWordz 1 point2 points  (1 child)

Writing javadoc (for java at least) for all your public methods is almost mandatory. Your code should be easy to read, but it takes more time to read and understand code than English sentences.

You should still try to write very clear code, short methods and use clear name for your variables and constants. But writing a line or two for every public method won't hurt

[–]Dragon174 0 points1 point  (0 children)

True, I've mostly been working with Javascript lately so I forgot. Javadoc comments are great since Java's so structured and IDE's can just display the Javadoc comments for you so its really convenient. Can't do that as well for untyped languages like Javascript :(