Aenigma / Aenigma/ActionMockup
Javadoc Should Not Containing Implementation Details
- Lingua principale
- Java
- Stelle
- 0
- Fork
- 0
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Comments are great. Javadocs are comments but not necessarily all comments are javadoc worthy.
Do not do things like make excuses for implementations and such for all public members. Perhaps move "personal" comments into non-javadoc comment blocks within the method block.
This task isn't high priority right now, though; just something that should be done between now and the final product. Over time, we should be listing out these kinds of comments and listing it here.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Direzione di ricerca
No files, tests, or entry points are named. Review the public-member Javadocs and identify implementation-detail comments, then move personal implementation notes into ordinary comments where appropriate and document the resulting list of changes in this issue.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100