Zend Framework

Coding Standards Version 1.0

Details

  • Type: Docs: Task Docs: Task
  • Status: Open Open
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: 0.6.0
  • Fix Version/s: Next Major Release
  • Component/s: None
  • Labels:
    None
  • Language:
    English

Description

Concerning the document located here:

http://framework.zend.com/wiki/x/PQ

We should should round out the details of this document and get it beyond release candidate and move it into the documentation.

A few things that need to be added or addressed:

  • Standard stock doc blocks for copy and paste purposes (page docblock, class docblock)
  • A more definitive guide on doc blocking... aim to standardize
  • Exception section updated to current standards
  • [other isses will be attached to this one]

Once this document is finalized (V1), i propose we evaluate all production (non-incubator code) and clean it up per the standards.

Issue Links

This issue is dependecy of:
ZF-703 Added committer irritating Trivial Resolved
ZF-108 Document Framework Requirements Major Resolved
ZF-507 Update all docblocks to use consistent copyright/license header. Major Resolved
ZF-8718 CLONE -Update all docblocks to use consistent copyright/license header. Version: 2010 Major Resolved
ZF-444 Distinguish between camelCaps and StudlyCaps and apply the term consistently across docs Minor Resolved
ZF-559 DocBlock Standardization Minor Resolved
ZF-503 Class Member Organizational Conventions Trivial Resolved
ZF-2509 One True Brace form... or is it? Trivial Closed

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Darby Felton added a comment -

Updated link

Show
Darby Felton added a comment - Updated link
Hide
Permalink
Darby Felton added a comment -

We might want to address array keys (e.g., component options) in the coding standard. A camelCase standard would correspond with already adopted variable and method naming conventions, though we would need a backward compatibility layer for many components that use the under_score naming convention for array keys.

Show
Darby Felton added a comment - We might want to address array keys (e.g., component options) in the coding standard. A camelCase standard would correspond with already adopted variable and method naming conventions, though we would need a backward compatibility layer for many components that use the under_score naming convention for array keys.
Hide
Permalink
Ralph Schindler added a comment -

We should include View Script (as well as Application code, Bootstrapping code, or any user code) best practices in this documentation.

Perhaps we should have a split in this document.

Part 1 would be for library coding standards
Part 2 would be for application coding standards

Show
Ralph Schindler added a comment - We should include View Script (as well as Application code, Bootstrapping code, or any user code) best practices in this documentation. Perhaps we should have a split in this document. Part 1 would be for library coding standards Part 2 would be for application coding standards
Hide
Permalink
Thomas Weidner added a comment -

There should also be a standard for API docblocks.
The actual situation is a quirks because everyone does his own.

Regarding coding standards in general it would be great to have a tool which does the check and returns standard-breaks to be fixed. But it should met ZF standard... a sort of modified phpbeautifier

Show
Thomas Weidner added a comment - There should also be a standard for API docblocks. The actual situation is a quirks because everyone does his own. Regarding coding standards in general it would be great to have a tool which does the check and returns standard-breaks to be fixed. But it should met ZF standard... a sort of modified phpbeautifier
Hide
Permalink
Wil Sinclair added a comment -

Resetting 'fix version priority' and 'fix version' to be re-evaluated for next release.

Show
Wil Sinclair added a comment - Resetting 'fix version priority' and 'fix version' to be re-evaluated for next release.
Hide
Permalink
Thomas Weidner added a comment -

For completeness the draft for the new standard can be found here:
http://framework.zend.com/wiki/display/ZFDEV/ZF+Coding+Standards+%28RC%29

Show
Thomas Weidner added a comment - For completeness the draft for the new standard can be found here: http://framework.zend.com/wiki/display/ZFDEV/ZF+Coding+Standards+%28RC%29
Hide
Permalink
Wil Sinclair added a comment -

Status? And if Thomas is doing work on this, let's break out his tasks in to subtasks and assign them to him.

Show
Wil Sinclair added a comment - Status? And if Thomas is doing work on this, let's break out his tasks in to subtasks and assign them to him.
Hide
Permalink
Thomas Weidner added a comment -

I've already created the CodeSniffer ruleset based on the old PHP Coding Standard from Darby and the new ZF Coding Standard from Ralph and me.

You can already try it out in the incubator under "tools". Actually it finds about 160.000 errors and is very strict in it's tests. It's not 100% finished but it gives already a good overview.

Show
Thomas Weidner added a comment - I've already created the CodeSniffer ruleset based on the old PHP Coding Standard from Darby and the new ZF Coding Standard from Ralph and me. You can already try it out in the incubator under "tools". Actually it finds about 160.000 errors and is very strict in it's tests. It's not 100% finished but it gives already a good overview.
Hide
Permalink
Wil Sinclair added a comment -

Updating to comply with new IT component conventions.

Show
Wil Sinclair added a comment - Updating to comply with new IT component conventions.
Hide
Permalink
Ralph Schindler added a comment -

reassigning

Show
Ralph Schindler added a comment - reassigning

People

Vote (6)
Watch (8)

Dates

  • Due:
    Created:
    Updated:

Time Tracking

Estimated:
1w
Original Estimate - 1 week Original Estimate - 1 week
Remaining:
1w 1h
Time Spent - 2 weeks, 4 hours Remaining Estimate - 1 week, 1 hour
Logged:
2w 4h
Time Spent - 2 weeks, 4 hours Remaining Estimate - 1 week, 1 hour
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Zend Framework. Try JIRA - bug tracking software for your team.