Write JavaDoc in an Instant (Part 1) – Templates for Methods

Write JavaDoc Example

We all love good and commented codes, but most of us either don’t know how to write a good comment for our codes, or just plain lazy to write one.

In Java, JavaDoc is pretty much the industry standard when it comes to auto-generated code tool. And as a strong believer of good software development practice, I always put comments on my code.

To save time, I created this template for methods so I can always refresh myself about how to write a good JavaDoc for my code. These codes are taken from the Java SDK source codes, so talk about how the creator of the Java write their comments (no one can be more expert than them I suppose).

*The template below is a slide presentation in Google Docs, to see the code expand its view to full screen, or you can download it as PDF or PPTX.

Author: Trijito Santoso

I’m Trijito Santoso, a Seventh-Day Adventist, a medical technology graduate, and a software developer. The reason why I shifted from medical technology to computer science is because I love to create things (design, software, articles, anything), and being a software developer allows me to create things everyday. I’m currently studying Master of Science in Computer Science at Northeastern University, Boston. My Google Profile+

Leave a Reply

Your email address will not be published. Required fields are marked *