Java Programming: Lesson 29 - Javadocs

PLEASE SUBSCRIBE!!!

In the previous two videos, we learned about ArrayLists:
https://youtu.be/QTpEpTilqBE (Lesson 27, basic ArrayList methods)
https://youtu.be/YZGg3ltLUbM (Lesson 28, ArrayLists of objects)

In this video, we talk about comments in the sense of providing formal documentation for classes that we write. We talk about why this is important, as well as where comments appear. This is compared against formal documentation that Java provides for its standard classes, like String and Character.

/** to start Javadocs above a class or method
Class javadocs should have a description of the class, an author, and a date
Method javadocs should have a description of the method, params (what the function accepts), and returns (what the function outputs).
Click Documentation rather than Source Code in your BlueJ IDE to view your class documentation.
As another option, documentation for static methods appears immediately before the method call, when passing in inputs.
**/ to end Javadocs

@param for an input, if any
@return for an output, if any

1:21 NEW: Intro to Javadocs
7:38 NEW: Documentation for a Static Method
15:35 NEW: Documentation for a Constructor
17:02 NEW: Documentation for a Setter Method and Getter Method
18:03 NEW: Documentation in an Independent Call to a Static Method

Python has something similar to Javadocs, and it's called docstrings. Check it out in part of this video: https://youtu.be/25UejFuE4TQ

In the next video, we will study a technique called recursion which allows us to repeat code without writing a single loop. https://youtu.be/CczHAlh7iE0 (Lesson 30)

Thanks for watching, and PLEASE SUBSCRIBE!!!