Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

User:Phalacee/Peer Review: Difference between revisions

From MoodleDocs
(Created page with "Peer review check-list Syntax No unnecessary blank lines Blank lines do not contain spaces Variables are named correctly (all lower case, no underscores) Functions are named cor...")
 
No edit summary
Line 1: Line 1:
Peer review check-list
Peer review check-list


Syntax
Syntax
No unnecessary blank lines
No unnecessary blank lines
Blank lines do not contain spaces
Blank lines do not contain spaces
Variables are named correctly (all lower case, no underscores)
Variables are named correctly (all lower case, no underscores)
Functions are named correctly
Functions are named correctly


Output
Output
Doesn't use buffered output unless absolutely necessary
Doesn't use buffered output unless absolutely necessary
Lang-strings used for output of text
Lang-strings used for output of text
No hard-coded strings for text output
No hard-coded strings for text output




Misc
Misc
Doesn't use deprecated functions https://docs.moodle.org/dev/Deprecated_functions_in_2.0
Doesn't use deprecated functions https://docs.moodle.org/dev/Deprecated_functions_in_2.0
Code makes sense in the broader scheme of things – look at the whole function, not just the altered code.
Code makes sense in the broader scheme of things – look at the whole function, not just the altered code.
If there is SQL code you can check quickly, do so.
If there is SQL code you can check quickly, do so.
Minimal DB calls (no excessive use of the DB).
Minimal DB calls (no excessive use of the DB).

Revision as of 01:05, 10 January 2012

Peer review check-list


Syntax

No unnecessary blank lines

Blank lines do not contain spaces

Variables are named correctly (all lower case, no underscores)

Functions are named correctly


Output

Doesn't use buffered output unless absolutely necessary

Lang-strings used for output of text

No hard-coded strings for text output


Misc

Doesn't use deprecated functions https://docs.moodle.org/dev/Deprecated_functions_in_2.0

Code makes sense in the broader scheme of things – look at the whole function, not just the altered code.

If there is SQL code you can check quickly, do so.

Minimal DB calls (no excessive use of the DB).