doc:howto:styleguide
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
doc:howto:styleguide [2011/07/10 22:42] – added a "common mistakes" section philip | doc:howto:styleguide [2017/09/22 13:28] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ==== Style Guide ==== | + | This page has been removed, in favor of [[http://doc.php.net/tutorial/style.php|new 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 " | + | |
- | * We follow the [[http:// | + | |
- | + | ||
- | === 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 %%& | + | |
- | * Using %%< | + | |
- | * Constants should be surrounded with %%< | + | |
- | * Functions should be surrounded with %%< | + | |
- | * Variables should be surrounded with %%< | + | |
- | * ... Create " | + | |
- | * Examples should use the [[http://pear.php.net/manual/en/ | + | |
- | + | ||
- | + | ||
- | === Common mistakes === | + | |
- | * Improper spacing. Mixing tabs with spaces, and indenting | + | |
- | * Long lines. Line width should not exceed 80 characters, although this is a loose requirement. 100 is probably fine, depending on the situation | + | |
- | * Committing leftover/ | + | |
- | * Windows line endings. Only use Unix line endings | + | |
- | * Having an IDE or Text editor remove trailing whitespace, then mixing it with commits. Don't do this | + | |
- | * Mixing %%& | + |
doc/howto/styleguide.1310337726.txt.gz · Last modified: 2017/09/22 13:28 (external edit)