Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]
Groups > comp.lang.python > #81228
| From | Grant Edwards <invalid@invalid.invalid> |
|---|---|
| Newsgroups | comp.lang.python |
| Subject | Re: Most gratuitous comments |
| Date | 2014-11-21 17:04 +0000 |
| Organization | PANIX Public Access Internet and UNIX, NYC |
| Message-ID | <m4nrao$6b8$1@reader1.panix.com> (permalink) |
| References | (2 earlier) <b932kb-isj.ln1@chris.zbmc.eu> <25fa214f-2060-46a8-bebf-d191d69e9a9c@googlegroups.com> <546e7644$0$13014$c3e8da3$5496439d@news.astraweb.com> <6ab51e97-19c5-4008-a755-c55eb71469ba@googlegroups.com> <87fvdd6o5c.fsf@elektro.pacujo.net> |
On 2014-11-21, Marko Rauhamaa <marko@pacujo.net> wrote:
> sohcahtoa82@gmail.com:
>
>> My point was that I was making fun of CS professors that demand a
>> comment on every line of code, regardless of how clear the line of
>> code is.
>
> Unfortunately, a lot of software houses do a similar thing. Not quite
> every line, but stuff like:
>
> def write_line_to_file(file, line):
> """Write a line to a file.
>
> file is the file to add a line to
> line is the line to add to the file"""
> ...
And then they run the whole steaming pile through doxygen to generate
several shelf-feet of utterly useless "documentation" to which than
can proudly point the next time the ISO-900<whatever> inspectors come
around. A few years later, the previously correct-but-pointless
comments and wheelbarrows full of paper are now incorrect, and instead
of providing zero value they provide _negative_ value.
--
Grant Edwards grant.b.edwards Yow! ... I'm IMAGINING a
at sensuous GIRAFFE, CAVORTING
gmail.com in the BACK ROOM of a
KOSHER DELI --
Back to comp.lang.python | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread
Most gratuitous comments Steven D'Aprano <steve@pearwood.info> - 2014-11-20 04:58 +0000
Re: Most gratuitous comments Chris Angelico <rosuav@gmail.com> - 2014-11-20 16:06 +1100
Re: Most gratuitous comments Mark Lawrence <breamoreboy@yahoo.co.uk> - 2014-11-20 12:04 +0000
Re: Most gratuitous comments sohcahtoa82@gmail.com - 2014-11-20 10:52 -0800
Re: Most gratuitous comments cl@isbd.net - 2014-11-20 21:32 +0000
Re: Most gratuitous comments sohcahtoa82@gmail.com - 2014-11-20 13:43 -0800
Re: Most gratuitous comments Steven D'Aprano <steve+comp.lang.python@pearwood.info> - 2014-11-21 10:16 +1100
Re: Most gratuitous comments sohcahtoa82@gmail.com - 2014-11-20 15:59 -0800
Re: Most gratuitous comments Chris Angelico <rosuav@gmail.com> - 2014-11-21 11:17 +1100
Re: Most gratuitous comments sohcahtoa82@gmail.com - 2014-11-20 16:19 -0800
Re: Most gratuitous comments Chris Angelico <rosuav@gmail.com> - 2014-11-21 11:33 +1100
Re: Most gratuitous comments Marko Rauhamaa <marko@pacujo.net> - 2014-11-21 08:52 +0200
Re: Most gratuitous comments Grant Edwards <invalid@invalid.invalid> - 2014-11-21 17:04 +0000
Re: Most gratuitous comments Marco Buttu <marco.buttu@gmail.com> - 2014-11-25 13:40 +0100
Re: Most gratuitous comments Marko Rauhamaa <marko@pacujo.net> - 2014-11-25 14:53 +0200
Re: Most gratuitous comments Steven D'Aprano <steve+comp.lang.python@pearwood.info> - 2014-11-26 01:47 +1100
Re: Most gratuitous comments Mark Lawrence <breamoreboy@yahoo.co.uk> - 2014-11-20 23:18 +0000
Re: Most gratuitous comments Dennis Lee Bieber <wlfraed@ix.netcom.com> - 2014-11-20 21:39 -0500
Re: Most gratuitous comments Stefan Behnel <stefan_ml@behnel.de> - 2014-11-20 20:09 +0100
Re: Most gratuitous comments albert@spenarnc.xs4all.nl (Albert van der Horst) - 2014-12-04 09:48 +0000
Re: Most gratuitous comments Rob Gaddi <rgaddi@technologyhighland.invalid> - 2014-12-04 09:12 -0800
Re: Most gratuitous comments sjmsoft@gmail.com - 2014-12-04 07:08 -0800
csiph-web