2963 shaares
21 private links
21 private links
- Document the background knowledge, the intention and not the result 2.Try to capture the concepts in a central place (e.g. wiki) - and only reference to the contents 3. Document obvious facts with marker tags - don't describe them over and over again (be DRY) [see Marker Annotation in p4j5] 4. Include in your documentation samples, how-to etc. (source code rules) 5. Don't allow default javadoc comments generated by the IDE 6. Sometime "No Doc, is the Best Doc" - try to minimize the amount of documentation and describe only the key concepts.