I am currently working on a rather large java project, and I am having small problems remembering what everything does right away, and am often continuously looking through the classes contents in order to remember exactly what everything does. Is there any conventional way of declaring what each class / method? I am looking for something similar to python's method declarations:
def foo(x):
'''
Takes and integer x and adds 1
'''
return x + 1
I strongly urge you to learn, practice and write Javadoc!
How to Write Doc Comments for the Javadoc Tool
You can write javadoc everywhere, because a javadoc is a comment. The javadoc tool (or your IDE - Netbeans for example) should give you insight when you hover (as appropriate). It's also used to generate the official API documentation. It is an example of "literate programming" and here is an official sample, namely File.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With