JavaDoc dokumentálás

[varszegimarcell]

Megkérnék szépen mindenkit, hogy bárki aki kódol, írjon a kódjához JavaDoc dokumentációt. Nem kell rizsázsni meg litániákat írni, de legyen egyértelmű hogy melyik kód mit csinál.

A JavaDoc nagyon hasonló a már Prog 3-mon mindenki által megismert DoxyGen dokumentációhoz, de a szintaktikája enyhén más. Egy kis tutorial a Javaban kevésbé jártas kollégáknak: https://www.tutorialspoint.com/java/java_documentation.htm

Az issuehoz csatolok egy Definition-of-done listát is, hogy mindenki elolvassa ezt a kis egyperces novellát.

• Marcell
• Kevin
• Dávid
• Péter

Köszi!

PRO TIP: Ha IntelliJ-t használsz, gépelj egy "/**"-ot, (idézőjelek nélkül!!!!!) majd nyomj egy entert az éppen kiszemelt dokumentálandó elem előtt. Az IDE automatikusan legenerálja neked a dokumentációhoz szükséges dolgokat, neked csak a rizsát kell megírni.