[TxMt] PHP Code Comments

Moshe Weitzman weitzman at tejasa.com
Fri Apr 25 17:59:10 UTC 2008


Nice!

Naturally, I have some requests/questions:

- use PHPDOC_AUTHOR and omit the line automatically if not defined. i
had to set author = false which means i am no longer using a pristine
copy and lose updates.
- How do I get rid of the blank line between the docblock and the
function signature?
- In Drupal, we put the description of each function on a new line
below the @param line. Any tips for how to do that? My ruby foo is
poor.
- Perhaps document the use 'tags' array by putting in the @see
keyword. Anyway, I'm not sure how to use this fully.
- get rid of doc_fp since it is a dupe and less capable

On Fri, Apr 25, 2008 at 1:34 PM, Peter Haza <peter.haza at gmail.com> wrote:
> If you write the function first, then go above the function and write doc⇥
> it will add @params for all the parameters.
>
>  ph
>
>
>
>  On Apr 25, 2008, at 4:22 PM, Moshe Weitzman wrote:
>
>
> > If you press the enter key instead of return, you will be able to
> > easily add new params and so on.
> >
> > The doc improvement i'm hoping for is for the doc_fp snippit to
> > automatically add @param items for each function/method parameter. It
> > can  regex out the number of params and their names.
> >
> > On Fri, Apr 25, 2008 at 9:17 AM, Thomas Allen <thomasmallen at gmail.com>
> wrote:
> >
> > > Neither of those options will print a new "  * " for each line, making
> it
> > > tedious to add more @params, etc. Is there a way to have TM insert that
> bit
> > > with every line in these blocks?
> > >
> > > 2008/4/25 Ciarán Walsh <ciawal at gmail.com>:
> > >
> > >
> > >
> > > >
> > > >
> > > > On 24 Apr 2008, at 18:51, Thomas Allen wrote:
> > > >
> > > >
> > > >
> > > > > The default block comment in the PHP bundle is:
> > > > > /*
> > > > > Comment...
> > > > > Comment...
> > > > > */
> > > > >
> > > > > The industry standard seems to be this:
> > > > > /**
> > > > > *  Comment...
> > > > > *  Comment...
> > > > > */
> > > > >
> > > > > How can I change this in TextMate?
> > > > >
> > > > >
> > > >
> > > > The "industry standard" you mention is used for docblocks, not regular
> > > >
> > > block comments. There is the /**⇥ snippet which Takaaki Kato mentioned,
> and
> > > also a doc⇥ snippet which inserts some relevant PHPDoc data.
> > >
> > > >
> > > >
> > > >
> > > > ______________________________________________________________________
> > > > For new threads USE THIS: textmate at lists.macromates.com
> > > > (threading gets destroyed and the universe will collapse if you don't)
> > > > http://lists.macromates.com/mailman/listinfo/textmate
> > > >
> > > >
> > >
> > >
> > >
> > > ______________________________________________________________________
> > > For new threads USE THIS: textmate at lists.macromates.com
> > > (threading gets destroyed and the universe will collapse if you don't)
> > > http://lists.macromates.com/mailman/listinfo/textmate
> > >
> > >
> >
> > ______________________________________________________________________
> > For new threads USE THIS: textmate at lists.macromates.com
> > (threading gets destroyed and the universe will collapse if you don't)
> > http://lists.macromates.com/mailman/listinfo/textmate
> >
>
>
>  ______________________________________________________________________
>  For new threads USE THIS: textmate at lists.macromates.com
>  (threading gets destroyed and the universe will collapse if you don't)
>  http://lists.macromates.com/mailman/listinfo/textmate
>


More information about the textmate mailing list