© Doug Winnie 2021
D. WinnieEssential Java for AP CompScihttps://doi.org/10.1007/978-1-4842-6183-5_35

35. Documenting with JavaDoc

Doug Winnie1  
(1)
Mission Hills, KS, USA
 

Only part of being a software developer or engineer is about building code. A large portion of your role is to build documentation to support your other developers and potentially external developers who use your code to use it correctly.

To assist with this task, a tool called JavaDoc allows you as a developer to create specially coded comments to hold documentation around specific methods and components of your code.

Using JavaDoc Syntax

JavaDoc uses unique codes to denote sections of code that are parsed by the JavaDoc builder to create HTML documents for your code. When you update ...

Get Essential Java for AP CompSci: From Programming to Computer Science now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.