Re: [development] QA: Consensus on comment formatting
IIRC: //* @TODO is also supported by doxygen. The extra * is what gets doxygen to parse it. -----Original Message----- From: development-bounces@drupal.org [mailto:development-bounces@drupal.org] On Behalf Of Angela Byron Sent: Monday, January 08, 2007 11:33 AM To: development@drupal.org; dopry@thing.net Subject: Re: [development] QA: Consensus on comment formatting On 8-Jan-07, at 1:31 PM, Darrel O'Pry wrote:
for phpdoc // @todo wouldn't work... /** @todo would word */
OK. In that case, I'm going to need to -1 @todo. /** stuff **/ as inline comments sucks, because then you can't comment out large blocks of code easily, which is something essential to debugging. That coupled with everyone else saying that // TODO is supported in their editor of choice makes this a closed case, imo. -Angie
On Jan 8, 2007, at 11:37 AM, Metzler, David wrote:
IIRC: //* @TODO is also supported by doxygen.
according to the docs[1] it's either: /// @todo or //! @todo i think /// is more readable. -derek [1] http://www.stack.nl/~dimitri/doxygen/docblocks.html (look for "For the brief description there are also several posibilities:", choice #3)
participants (2)
-
Derek Wright -
Metzler, David