Developer on Alibaba Coud: Build your first app with APIs, SDKs, and tutorials on the Alibaba Cloud. Read more ＞
Comments cannot beautify bad code
Use code to describe your ideas
What is a good comment?
Provide information comments
Explanation of intent
Warning: for example, // don't run unless you have some time to kill
Javadoc for public APIs
What are bad comments?
Track-based annotation: It is silly to say that every function requires javadoc to live and every variable requires annotations. Such annotations can only make the code messy.
Nonsense comment: default constructor
Too much information: Do not write anything in comments, and write all the details... My God.
Use uncontrollable exceptions whenever possible
Environment Description of exceptions
Do not return NULL values
Do not pass null values
This article is an English version of an article which is originally in the Chinese language on aliyun.com and is provided for information purposes only. This website makes no representation or warranty of any kind, either expressed or implied, as to the accuracy, completeness ownership or
reliability of the article or any translations thereof. If you have any concerns or complaints relating to the article, please send an email, providing a detailed description of the concern or
complaint, to email@example.com. A staff member will contact you within 5 working days. Once verified, infringing content will be removed immediately.
The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion;
products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the
content of the page makes you feel confusing, please write us an email, we will handle the problem
within 5 days after receiving your email.
If you find any instances of plagiarism from the community, please send an email to:
and provide relevant evidence. A staff member will contact you within 5 working days.