PhpGtk.DocumentationTeamStandards 4.0 KB

12345678910111213141516
  1. version=pmwiki-1.0.5
  2. newline=²
  3. text=When contributing to the documentation please adhere to the following standards.²²!!Doc Book²* Anytime a class, method, function, constant, property, or signal is mentioned it should be linked to the appropriate page in the manual.²²--> ...return the widget's <classname>GtkStyle</classname>...²²*Text should wrap on or about 78 characters per line.²²!!Example Code²!!!Spacing²*All indents should be four spaces. No tabs!²*Use the minimum amount of spaces possible while maintaining readability.²²Bad example:\\²if ( ( $a == 0 ) && ( $b < 0 ) ) {² $one='one';² $two='two';² $three='three';²}²²Good example:\\²if (($a == 0) && ($b < 0)) {² $one = 'one';² $two = 'two';² $three = 'three';²}²²!!!Functions²When defining a function, the curly brace should appear on the line after the function keyword.²²When calling or defining a function, there should be no space between the function name and the opening parenthesis.²²function foo($one, $two = 'three')²{² return $one . ' ' . $two;²}\\²echo foo('one', 'two');²²!!!Control structures²Control structures should have one space between the key word and the opening parenthesis.²²When there are multiple conditions, each condition should be enclosed within its own set of parenthesis.²²Curly braces should appear on the same line as the key word.²²if ((condition1) || (condition2)) {² action1;²} elseif ((condition3) && (condition4)) {² action2;²} else {² defaultaction;²}²²!!!The new operator²When instantiating a new object, do not use &new. Instead put the & adjacent to the equals sign.²²$window =& new GtkWindow;²²\\²Adopted from http://pear.php.net/manual/en/standards.php
  4. time=1116976630
  5. diff:1092082507:1092082507:=1,61c1²< When contributing to the documentation please adhere to the following standards.²< ²< !!Doc Book²< * Anytime a class, method, function, constant, property, or signal is mentioned it should be linked to the appropriate page in the manual.²< ²< --> ...return the widget's <classname>GtkStyle</classname>...²< ²< *Text should wrap on or about 78 characters per line.²< ²< !!Example Code²< !!!Spacing²< *All indents should be four spaces. No tabs!²< *Use the minimum amount of spaces possible while maintaining readability.²< ²< Bad example:\\²< if ( ( $a == 0 ) && ( $b < 0 ) ) {²< $one='one';²< $two='two';²< $three='three';²< }²< ²< Good example:\\²< if (($a == 0) && ($b < 0)) {²< $one = 'one';²< $two = 'two';²< $three = 'three';²< }²< ²< !!!Functions²< When defining a function, the curly brace should appear on the line after the function keyword.²< ²< When calling or defining a function, there should be no space between the function name and the opening parenthesis.²< ²< function foo($one, $two = 'three')²< {²< return $one . ' ' . $two;²< }\\²< echo foo('one', 'two');²< ²< !!!Control structures²< Control structures should have one space between the key word and the opening parenthesis.²< ²< When there are multiple conditions, each condition should be enclosed within its own set of parenthesis.²< ²< Curly braces should appear on the same line as the key word.²< ²< if ((condition1) || (condition2)) {²< action1;²< } elseif ((condition3) && (condition4)) {²< action2;²< } else {²< defaultaction;²< }²< ²< !!!The new operator²< When instantiating a new object, do not use &new. Instead put the & adjacent to the equals sign.²< ²< $window =& new GtkWindow;²< ²< \\²< [- Adopted from http://pear.php.net/manual/en/standards.php -]²\ No newline at end of file²---²> Describe DocumentationTeamStandards here.²\ No newline at end of file²
  6. author=scott
  7. author:1092082507=scott
  8. host:1092082507=68.167.115.34
  9. name=PhpGtk.DocumentationTeamStandards
  10. host=68.199.17.225
  11. agent=Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.3) Gecko/20040910
  12. rev=13
  13. diff:1092082543:1092082507:minor=61c61²< Adopted from http://pear.php.net/manual/en/standards.php²\ No newline at end of file²---²> [- Adopted from http://pear.php.net/manual/en/standards.php -]²\ No newline at end of file²
  14. author:1092082543=scott
  15. host:1092082543=68.167.115.34