JavaDoc

  • As discussed with the customer, all public elements should be documented with JavaDoc.
  • Pascal's standard (reengineered from his comments):
    • Quality is more important than quantitiy.
    • ~ 1 sentences per class or interface
    • ~ 1 sentence per public method plus
      • ~ 1 sentence per parameter and return value
      • ~ 1 sentence for exceptional behavior like how “null” values will be treated.

Setting up Eclipse to point us to missing JavaDoc

Enable check for JavaDoc for public not-overriding/implementing program elements

  • Open “Window > Preferences”
  • Select “Java > Compiler > JavaDoc”
  • Enable “Process Javadoc comments”
  • Set “Missing Javadoc comments:” to “Warning”
  • That's it for now. This is the most relaxed convention. The dialog should look like:

Configure Problems view contents

  • Open “Windows > Show View > Problems”
  • Select “Configure Contents …” from the menu of the view
  • Press “New…”
    • Enter “JavaDoc Problem on Children”
  • Select for Scope: “On selected element and its children”
  • For “Description” enter in the edit box “Javadoc:”
  • For “Types” deselect all and then select “Java Problems”

  • Now you can use “Show > JavaDoc Problem on Children” from the menu of the view to focus on the JavaDoc problems.
  • Select in the package explorer the “src” folder to get the total number of violations in this folder.
Last modified: 2017/08/31 20:25
*