w3-tools.com - Free Webmaster Tools and Resources
  		w3-tools.com - Free Webmaster Tools and Resources
 Free Webmaster Tools and Resources

 



PEAR Manual

This manual is provided as a courtesy. It is not an official source. Please check pear.php.net for updated information.

PEAR Manual

PEAR Manual
PEAR Manual
PrevNext

Chapter 4. Coding Standards

Table of Contents
Indenting and Line Length
Control Structures
Function Calls
Function Definitions
Comments
Including Code
PHP Code Tags
Header Comment Blocks
Using CVS
Example URLs
Naming Conventions
File Formats
Sample File (including Docblock Comment standards)

Note: The PEAR Coding Standards apply to code that is part of the official PEAR distribution (that is, either distributed with PHP or available for download from the PHP PEAR repository).

Indenting and Line Length

Use an indent of 4 spaces, with no tabs. If you use Emacs to edit PEAR code, you should set indent-tabs-mode to nil. Here is an example mode hook that will set up Emacs according to these guidelines (you will need to ensure that it is called when you are editing PHP files): 

(defun php-mode-hook ()
  (setq tab-width 4
        c-basic-offset 4
        c-hanging-comment-ender-p nil
        indent-tabs-mode
  (not
    (and (string-match "/\\(PEAR\\|pear\\)/" (buffer-file-name))
      (string-match "\.php$" (buffer-file-name))))))

Here are vim rules for the same thing: 

set expandtab
set shiftwidth=4
set softtabstop=4
set tabstop=4

It is recommended that you break lines at approximately 75-85 characters. There is no standard rule for the best way to break a line, use your judgment and, when in doubt, ask on the PEAR Quality Assurance mailing list.

PrevHomeNext
#PEAR on IRCUpControl Structures

Newsletter
Join to our newsletter and receive news and updates about our site.
Your name: 
E-mail address: 
Action: 
 

Hosted by

Search
Google
Web w3-tools.com

Links
  What is my IP? Find your IP address!     Valid XHTML 1.0 Transitional  
Copyright © 2006. by w3-tools.com. All rights reserved