I do a lot of Java programming at my work (I'm an intern) and I was wondering if it is generally a rule to create javadoc to accompany my code. I usually document every method and class anyways, but I find it hard to adhere to Javadoc's syntax (writing down the variables and the output so that the parser can generate html).I've looked at a lot of C programming and even C++ and I like the way they are commented. Is it wrong not to supply javadoc with my code?
Is it wrong not to create Javadoc for my code?
java;documentation;comments
In any writing, you write for your audience. Your audience is the maintenance developer, which may be you after 3 years after you have forgotten the details of how it all works.Single use throw away code, probably can be commented less. APIs to be consumed by other developers needs to be documented more.In no case does anyone need javadoc that only repeats the method signature (e.g. This is a method with a return value of void and a name of HelloWorld and is invoked with no paramters)