doc:howto:styleguide

This is an old revision of the document!


Style Guide

This style guide affects the PHP Manual.

Reference

We follow the following style guide as a base:

  • A first-person active voice is preferred, which also means do not address the reader directly as “You”

Conventions specific to the PHP Manual

  • The refpurpose should not end with a period
  • Indenting is one space, and never tabs
  • Whitespace changes should never be mixed with content changes
  • Text that's repeated 3x or more should be defined as an entity within language-snippets.ent
  • Many words, such as TRUE, FALSE, and NULL, should use the entity versions instead, like &true;
  • Using <para> or <simpara> does not matter, but <para> is preferred
  • Constants should be surrounded with <constant>, like <constant>PHP_EOL</constant>
  • Functions should be surrounded with <function>, like <function>strlen</function> (Or, <methodname> for methods)
  • Variables should be surrounded with <varname> like <varname>$foo</varname>
  • ... Create “common docbook tag usages” instead of repeating....
  • Examples should use the PEAR Coding Standards
doc/howto/styleguide.1310337142.txt.gz · Last modified: 2017/09/22 13:28 (external edit)