phpBB

Development Discussion Board

phpBB's testing ground of bleeding edge code
Advanced search

@since

Discuss general development subjects that are not specific to a particular version like the versioning control system we use or other infrastructure.

@since

Postby Oleg » Tue Feb 08, 2011 5:59 am

(Inspired by cs278's timezone diffs.)

What about using @since to indicate which version a feature was introduced in? Useful? Not useful since nothing but the latest version is ever supported for anything?
Oleg
3.1 Release Manager
3.1 Release Manager
 
Posts: 1150
Joined: Tue Feb 23, 2010 2:38 am

Re: @since

Postby igorw » Tue Feb 08, 2011 9:57 am

Nice to have, no objections. Using it for new stuff should be sufficient.
User avatar
igorw
Registered User
 
Posts: 500
Joined: Thu Jan 04, 2007 11:47 pm

Re: @since

Postby naderman » Sat Feb 12, 2011 10:14 pm

Agreed, would be nice if someone could add this to new stuff already added in 3.1 and add a rule to coding guidelines for both 3.0 & 3.1.
www.naderman.de
Move your forum to Forumatic - we'll take care of maintenance & spam
User avatar
naderman
Development Team Leader
Development Team Leader
 
Posts: 1649
Joined: Sun Jan 11, 2004 2:11 am
Location: Karlsruhe, Germany

Re: @since

Postby Oleg » Sat Feb 12, 2011 10:21 pm

If we decide to use @since then we need to also adjust it whenever we change function signatures.

I think we should only use @since if we find an actual use for it. It sure is pretty but I don't think prettiness alone warrants the upkeep.
Oleg
3.1 Release Manager
3.1 Release Manager
 
Posts: 1150
Joined: Tue Feb 23, 2010 2:38 am

Re: @since

Postby igorw » Sun Feb 13, 2011 12:09 pm

nn- wrote:If we decide to use @since then we need to also adjust it whenever we change function signatures.

I'd rather use it to indicate when a class or method was introduced. And potentially add a "(introduced in 3.0.x)" to the @param if it's significant.
User avatar
igorw
Registered User
 
Posts: 500
Joined: Thu Jan 04, 2007 11:47 pm

Re: @since

Postby Oleg » Sun Feb 13, 2011 2:24 pm

What is the benefit of such indication?
Oleg
3.1 Release Manager
3.1 Release Manager
 
Posts: 1150
Joined: Tue Feb 23, 2010 2:38 am

Re: @since

Postby igorw » Sun Feb 13, 2011 4:29 pm

As per IRC, this is more consistent with the PHP manual.
User avatar
igorw
Registered User
 
Posts: 500
Joined: Thu Jan 04, 2007 11:47 pm


Return to General Development Discussion

Who is online

Users browsing this forum: No registered users and 9 guests