PHP comments

Randy · 06-13-2009, 04:54 PM

Not quite sure where this would go so i thought i'd stick it here. I am curious when you create a something using PHP do you add a copyright near the top or bottom? and if so what kind do you do.

For me it depends on what kind of project it is, if its an open-source project or just a mess around project use something like this:

Quote:

/**
* @version 1.0
* @package PROJECTNAME
* @copyright Copyright (C) 2009 PROJECTNAME. All rights reserved.
* @license GNU/GPL, see LICENSE.txt
* RemixCMS is free software. This version may have been modified pursuant to the GNU General Public
* License, and as distributed it includes or is derivative of works licensed under the GNU General Public
* License or other free or open source software licenses.
* See COPYRIGHT.php for copyright notices and details.
*/

But if its like a something that is personal use only or something i tend to pull what vBulletin does:

Quote:

/*================================================= =====================*\
||
|| PROJECT NAME
||
|| --------------------------------------------------------------
||
|| Copyright (c)2009-2010 My Company. All Rights Reserved.
|| This file may not be redistributed in whole or significant part.
|| PROJECT NAME IS NOT FREE SOFTWARE
|| my website url | my tos or client area url
||
\*================================================ ======================*/

What about you?

Wildhoney · 06-13-2009, 05:32 PM

I use only the PHPDoc style comments as you have there in your first example. Then I really only use the abstract and return parameters. With others depending on if it's useful.

Jim · 06-22-2009, 01:44 PM

Same as WH here. The first one is supported quite nicely by Zend Studio so it makes developing with others more easy.

And i don't like the big fancy comment blocks, just takes space...