Differential D9695 Diff 23261 src/docs/contributor/general_coding_standards.diviner

Changeset View

Standalone View

	Show First 20 Lines • Show All 63 Lines • ▼ Show 20 Lines
	gather concrete performance data.			gather concrete performance data.


	= Naming Things =			= Naming Things =

	- Follow language-specific conventions.			- Follow language-specific conventions.
	- Name things unambiguously.			- Name things unambiguously.
	- Choose descriptive names.			- Choose descriptive names.
	- Avoid nonstandard abbreviations (common abbreviations like ID, URI and HTTP are fine).			- Avoid nonstandard abbreviations (common abbreviations like ID, URI and HTTP
				are fine).
	- Spell words correctly.			- Spell words correctly.
	- Use correct grammar.			- Use correct grammar.

	For example, avoid these sorts of naming choices:			For example, avoid these sorts of naming choices:

	COUNTEREXAMPLE			COUNTEREXAMPLE
	$PIE->GET_FLAVOR(); // Unconventional.			$PIE->GET_FLAVOR(); // Unconventional.
	$thing->doStuff(); // Ambiguous.			$thing->doStuff(); // Ambiguous.
	▲ Show 20 Lines • Show All 67 Lines • Show Last 20 Lines