«

Like in C we comment like
/*
Bunch of lines of code
*/

Should we use docstring """ """

Or there is something else too ??

Every help is appreciated.

Thanks

Em Qui, 2006-03-30 Ã*s 15:21 -0800, escreveu:
> Like in C we comment like
> /*
> Bunch of lines of code
> */
>
> Should we use docstring """ """
>
> Or there is something else too ??

You should use a decent editor that could automatically
comment/uncomment code upon your request.

HTH,

--
Felipe.

>>Or there is something else too ??
>
> You should use a decent editor that could automatically
> comment/uncomment code upon your request.

In Vim, you can map a key to do the following:

:s/^/#

to comment the highlighted lines, and

:s/^#

to uncomment them. To map them, you can use

:vnoremap <f4> :s/^/#<cr>
:vnoremap <f5> :s/#<cr>

(those are literal "less-than, ["eff, [4 | 5]" | "see,
are"], greater-than" characters)

Then, pressing <f4> in visual mode will comment the selected
lines, and pressing <f5> will uncomment any selected lines
that are commented.

The nice thing about vim's method of doing this, is that you
can combine it with grepping. If you want to comment out
every line containing a regexp, you can do

:g/regexp/s/^/#

Or, if you want to comment out from "regexp_1" to the
following line containing "regexp_2", you can use

:g/regexp_1/.,/regexp2/s/^/#

All sorts of handy tricks.

There are python plugins that I'm sure offer such abilities
built-in. There are likely ways to do this in other editors
too. I just happen to be a vim sorta guy.

-tkc

wrote:

> Like in C we comment like
> /*
> Bunch of lines of code
> */
>
> Should we use docstring """ """
>
> Or there is something else too ??
>
> Every help is appreciated.
>
> Thanks
Hi,

Maybe this sounds simplier than regexp and so, just use the """ marker like
this :

"""
this
would be
commented
during
execution
"""

wrote:
> Like in C we comment like
> /*
> Bunch of lines of code
> */
>
> Should we use docstring """ """

I would say NO.
docstring are displayed by pydoc, thus a pydoc on your code will display some
inconsistent information

> Or there is something else too ??

some moderns editors allow you to comment/uncomment a selected Bunch
of lines of code

Eric
--
> afin de parfaire mon apprentissage de linux,je cherche sur lille et sa
> périphérie une nana tout linux
JPH in Guide du linuxien pervers : "Connaître le système"

Eric Deveaud wrote:
> wrote:
> > Like in C we comment like
> > /*
> > Bunch of lines of code
> > */
> >
> > Should we use docstring """ """
>
> I would say NO.
> docstring are displayed by pydoc, thus a pydoc on your code will display some
> inconsistent information
>

docstrings are a bit of a magical construct. Not all strings in a
function are docstrings.

>>> def foo():
.... "real docstring"
.... """
.... x=1
.... """
.... print x
....
>>> help(foo)
Help on function foo in module __main__:

foo()
real docstring

>>>

wrote:
>
> Eric Deveaud wrote:
> > wrote:
> > > Like in C we comment like
> > > /*
> > > Bunch of lines of code
> > > */
> > >
> > > Should we use docstring """ """
> >
> > I would say NO. docstring are displayed by pydoc, thus a pydoc on your
> > code will display some inconsistent information
> >
>
> docstrings are a bit of a magical construct. Not all strings in a
> function are docstrings.


yep fogotten that triple quotted strings are considered as docstring
only if they are the first lines of the module/fonction/class/method
excluding the comments lines.

my bad

Eric

--
SYBEX ORIGINAL SOFTWARE
NOUVEAU KIT LINUX REDHAT 5.2 POUR WIN 95/98
-+- Sybex in Guide du linuxien pervers - "L'incompétance en action" -+-

Eric Deveaud wrote:
> wrote:
>
>> Eric Deveaud wrote:
>>
>>> wrote:
>>>
>>>> Like in C we comment like
>>>> /*
>>>> Bunch of lines of code
>>>> */
>>>>
>>>> Should we use docstring """ """
>>>>
>>> I would say NO. docstring are displayed by pydoc, thus a pydoc on your
>>> code will display some inconsistent information
>>>
>>>
>> docstrings are a bit of a magical construct. Not all strings in a
>> function are docstrings.
>>
>
>
> yep fogotten that triple quotted strings are considered as docstring
> only if they are the first lines of the module/fonction/class/method
> excluding the comments lines.
>
The official rule is that if *any* string is the first line of a
function/etc, it is considered a docstring. It's just standard
convention to use the triple quotes for docstrings. As you mentioned,
you can use triple quotes for any string; likewise, you can use standard
quotes ( ' or " ) for docstrings as well.

- Mike

I often use

if 0:
bunch of lines of code

That way, it's very easy to reenable the code, or to add an else, etc.
I can even put things like 'if 0 and USE_FOO_FEATURE' to document what
is being commented out. It's much more flexible than commenting out.

--
Want to play tabletop RPGs over the internet?
Check out Koboldsoft RPZen: http://www.koboldsoft.com

wrote:
> Like in C we comment like
> /*
> Bunch of lines of code
> */
>

scite has a feature where you modify your delimiter in block comments,
i.e. what comes after "#"

http://scintilla.sourceforge.net/SciTEDoc.html