Actions

Coding Checklist

From Joomla! Documentation

Here are some issues that should be checked during the code review of a proposed patch.

  1. Do all non-private members have PHPdoc comments?
  2. Is the commenting correct?
    1. Does it generate correct PHPDocs?
    2. Are all parameters, return values, etc. commented?
  3. Is all complex or non-obvious logic commented?
  4. Is the logic as simple as it can be?
  5. Are all coding standards enforced?
  6. Are Joomla patterns consistently implemented?
  7. Are methods short?
  8. Are abbreviations minimized and consistent?
  9. Do PHPDocs include examples?
  10. If the code is in the platform, does it include unit tests and are unit tests thorough?