ZF-559: DocBlock Standardization

Issue Type: Coding Standards Violation Created: 2006-11-15T13:03:02.000+0000 Last Updated: 2008-09-02T10:39:21.000+0000 Status: Resolved Fix version(s): - 1.6.0 (02/Sep/08)

Reporter: Darby Felton (darby) Assignee: Thomas Weidner (thomas) Tags: Related issues: - ZF-691



The coding standards should provide accurate docblocks that can be cut and pasted into code by framework developers:

The current examples do not reflect de facto standards in the framework code base.


Posted by Ralph Schindler (ralph) on 2006-12-28T14:51:10.000+0000

Linked to doc standards cleanup

Posted by Simone Carletti (weppos) on 2007-11-11T18:13:09.000+0000

+1 for this ticket.

I'm feeling a bit confused. Here you suggest to use a block with a license that is no longer the right one (see ZF-507).

Here ZF-703 Bill agree to include SVN $Id$ keyword in files but I can't find many files using it in the latest ZF release.

Many files have different copyright string with basically the same information

{quote} Copyright (c) 2005-2007 Zend Technologies USA Inc. ( Copyright (c) 2005-2008 Zend Technologies USA Inc. ( Copyright (c) 2005-2007 Zend Technologies USA Inc. ( Copyright (c) 2007 Jordan Raub and Felix Jendrusch {quote}

A definitive standard would be more than welcome. :)

Posted by Wil Sinclair (wil) on 2008-03-21T17:05:30.000+0000

This issue should have been fixed for the 1.5 release.

Posted by Wil Sinclair (wil) on 2008-04-18T13:12:05.000+0000

This doesn't appear to have been fixed in 1.5.0. Please update if this is not correct.

Posted by Wil Sinclair (wil) on 2008-04-18T17:04:41.000+0000

Thomas, aren't you working on this now? If so, please close this when you are finished. Otherwise, feel free to unassign it from yourself.

Posted by Thomas Weidner (thomas) on 2008-04-18T17:13:21.000+0000

I'm working on the coding standard testbed which will then also close this issue.

Actually I've already fixed this issue for the existing files, but as new files are added we will for now have the problem also for them. See r9245 where darby added the header for a new file afterwards.

I will keep this issue opened until I have finished the testbed. Ralph and me are working on closing the whole bunch of issues related to this.

Posted by Wil Sinclair (wil) on 2008-06-15T21:22:01.000+0000

Updating to comply with new IT component conventions.

Posted by Thomas Weidner (thomas) on 2008-06-16T07:49:39.000+0000

The Docblock is checked and forced by the new CodeSniffer ruleset. Actually all files within the core have the new docblock integrated.

Posted by Wil Sinclair (wil) on 2008-09-02T10:39:21.000+0000

Updating for the 1.6.0 release.

Have you found an issue?

See the Overview section for more details.


© 2006-2019 by Zend, a Rogue Wave Company. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.