-
Notifications
You must be signed in to change notification settings - Fork 0
javadoc conventions
Strandtasche edited this page Dec 21, 2013
·
1 revision
- Eigentliches JavaDoc mit großem Anfangsbuchstaben und enden mit einem Punkt.
- nach @param "parameter", @return und @throw klein weiter und ohne Punkt beenden.
- @param context The context which is transmitted. !FALSCH!
- @param context the context which is transmitted !RICHTIG!
- bei @param nicht den übergebenen parameter einfach in den Satzfluss stellen
- @param context is given !FALSCH!
- @param context the context is given !RICHTIG!
- bei @return nicht return im Satz benutzen.
- @return returns content of the method !FALSCH!
- @return the content of the method is returned !FALSCH!
- @return the content of the method !RICHTIG!