Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]
Groups > comp.lang.python > #197668
| From | ram@zedat.fu-berlin.de (Stefan Ram) |
|---|---|
| Newsgroups | comp.lang.python |
| Subject | Comments (was: Python) |
| Date | 2026-03-04 17:17 +0000 |
| Organization | Stefan Ram |
| Message-ID | <comments-20260304175558@ram.dialup.fu-berlin.de> (permalink) |
| References | (18 earlier) <mqgdu2Fng8U3@mid.individual.net> <fsidnRnSK9Uz7d70nZ2dnZfqnPednZ2d@giganews.com> <10i13o0$c16d$1@dont-email.me> <wwvike3r7oy.fsf@LkoBDZeT.terraraq.uk> <10o9mre$327a7$3@dont-email.me> |
"Michael F. Stemper" <michael.stemper@gmail.com> wrote or quoted:
>The bad news? I knew enough German to be able to tell that the two paired
>comments sometimes disagreed on what was being done or how it was done.
Comments in two different languages seem to be add additional
workload and a distraction with little benefit. Every programmer
can read and write English.
There are several types of comments:
- documentation comments tell callers how to use a feature
documenting its interfaces,
- implementation comments explain how an implementation
accomplishes (implements) a given interface,
- work comments contain notes for programmers helping them
build and change the code, such as "todo: . . .", "fixme:
. . ."), etc., and
- log comments provide a history of the project and of edit
sessions.
Implementation comments should not try to reduplicate what the
code obviously does, but rather explain, what a piece of code
is /intended/ to do and /why/ certain choices where made.
Newsgroups: comp.lang.python
Back to comp.lang.python | Previous | Next — Previous in thread | Next in thread | Find similar
Re: Python Lawrence D’Oliveiro <ldo@nz.invalid> - 2025-12-14 23:29 +0000
Re: Python mm0fmf <none@invalid.com> - 2025-12-15 12:57 +0000
Re: Python Alexander Schreiber <als@usenet.thangorodrim.de> - 2025-12-15 22:57 +0100
Re: Python c186282 <c186282@nnada.net> - 2025-12-15 22:31 -0500
Re: Python Greg Ewing <greg.ewing@canterbury.ac.nz> - 2025-12-16 17:51 +1300
Re: Python rbowman <bowman@montana.com> - 2025-12-16 08:32 +0000
Re: Python Lawrence D’Oliveiro <ldo@nz.invalid> - 2025-12-16 21:45 +0000
Re: Python rbowman <bowman@montana.com> - 2025-12-17 01:54 +0000
Re: Python c186282 <c186282@nnada.net> - 2025-12-17 03:11 -0500
Re: Python rbowman <bowman@montana.com> - 2025-12-17 19:17 +0000
Re: Python c186282 <c186282@nnada.net> - 2025-12-17 22:10 -0500
Re: Python John Levine <johnl@taugh.com> - 2025-12-18 03:28 +0000
Re: Python c186282 <c186282@nnada.net> - 2025-12-17 23:02 -0500
Re: Python rbowman <bowman@montana.com> - 2025-12-18 06:54 +0000
Re: Python c186282 <c186282@nnada.net> - 2025-12-18 04:25 -0500
Re: Python rbowman <bowman@montana.com> - 2025-12-18 19:22 +0000
Re: Python c186282 <c186282@nnada.net> - 2025-12-19 01:14 -0500
Re: Python rbowman <bowman@montana.com> - 2025-12-18 06:44 +0000
Re: Python Peter Flass <Peter@Iron-Spring.com> - 2025-12-18 07:40 -0700
Re: Python Richard Kettlewell <invalid@invalid.invalid> - 2025-12-18 18:00 +0000
Re: Python rbowman <bowman@montana.com> - 2025-12-18 18:28 +0000
Re: Python Peter Flass <Peter@Iron-Spring.com> - 2025-12-18 12:52 -0700
Re: Python rbowman <bowman@montana.com> - 2025-12-19 03:53 +0000
Re: Python c186282 <c186282@nnada.net> - 2025-12-19 00:37 -0500
Re: Python "Michael F. Stemper" <michael.stemper@gmail.com> - 2026-03-04 10:32 -0600
Comments (was: Python) ram@zedat.fu-berlin.de (Stefan Ram) - 2026-03-04 17:17 +0000
Re: Python ted@loft.tnolan.com (Ted Nolan <tednolan>) - 2026-03-04 20:01 +0000
Re: Python "Carlos E.R." <robin_listas@es.invalid> - 2026-03-04 21:29 +0100
Re: Python Lawrence D’Oliveiro <ldo@nz.invalid> - 2026-03-04 20:37 +0000
Re: Python Peter Flass <Peter@Iron-Spring.com> - 2026-03-04 14:09 -0700
Re: Python Lawrence D’Oliveiro <ldo@nz.invalid> - 2026-03-04 22:35 +0000
Re: Python Nuno Silva <nunojsilva@invalid.invalid> - 2026-03-04 23:10 +0000
Re: Python c186282 <c186282@nnada.net> - 2026-03-04 20:30 -0500
Re: Python Peter Flass <Peter@Iron-Spring.com> - 2026-03-04 20:13 -0700
Re: Python Lawrence D’Oliveiro <ldo@nz.invalid> - 2026-03-05 03:49 +0000
Re: Python Charlie Gibbs <cgibbs@kltpzyxm.invalid> - 2026-03-05 17:42 +0000
Re: Python "Carlos E.R." <robin_listas@es.invalid> - 2026-03-05 20:02 +0100
Re: Python c186282 <c186282@nnada.net> - 2026-03-05 14:42 -0500
Re: Python Nuno Silva <nunojsilva@invalid.invalid> - 2026-03-06 00:12 +0000
Re: Python Bob Eager <news0009@eager.cx> - 2026-03-06 09:02 +0000
Re: Python Charlie Gibbs <cgibbs@kltpzyxm.invalid> - 2026-03-05 02:44 +0000
Re: Python Lawrence D’Oliveiro <ldo@nz.invalid> - 2026-03-05 03:50 +0000
Re: Python Piergiorgio Sartor <piergiorgio.sartor.this.should.not.be.used@nexgo.REMOVETHIS.de> - 2026-03-04 22:14 +0100
Re: Python The Natural Philosopher <tnp@invalid.invalid> - 2026-03-04 22:20 +0000
Re: Python c186282 <c186282@nnada.net> - 2025-12-19 00:29 -0500
Re: Python "Carlos E.R." <robin_listas@es.invalid> - 2025-12-20 12:38 +0100
Re: Python Dan Espen <dan1espen@gmail.com> - 2025-12-17 16:17 -0500
Re: Python Lawrence D’Oliveiro <ldo@nz.invalid> - 2025-12-17 22:11 +0000
Re: Python c186282 <c186282@nnada.net> - 2025-12-17 22:18 -0500
Re: Python rbowman <bowman@montana.com> - 2025-12-18 07:07 +0000
Re: Python Richard Kettlewell <invalid@invalid.invalid> - 2025-12-17 22:13 +0000
Re: Python rbowman <bowman@montana.com> - 2025-12-18 00:52 +0000
Re: Python Marc Haber <mh+usenetspam1118@zugschl.us> - 2025-12-18 08:03 +0100
Re: Python rbowman <bowman@montana.com> - 2025-12-18 07:39 +0000
Re: Python scott@slp53.sl.home (Scott Lurndal) - 2025-12-18 15:43 +0000
Re: Python rbowman <bowman@montana.com> - 2025-12-18 18:38 +0000
Re: Python c186282 <c186282@nnada.net> - 2025-12-19 00:56 -0500
Re: Python rbowman <bowman@montana.com> - 2025-12-19 08:18 +0000
Re: Python c186282 <c186282@nnada.net> - 2025-12-19 03:30 -0500
Re: Python rbowman <bowman@montana.com> - 2025-12-19 19:38 +0000
Re: Python c186282 <c186282@nnada.net> - 2025-12-20 04:01 -0500
Re: Python rbowman <bowman@montana.com> - 2025-12-21 04:08 +0000
Re: Python "Carlos E.R." <robin_listas@es.invalid> - 2025-12-27 22:36 +0100
i3 (was: Python) Axel Reichert <mail@axel-reichert.de> - 2025-12-19 08:57 +0100
Re: Python The Natural Philosopher <tnp@invalid.invalid> - 2025-12-18 09:55 +0000
Re: Python Marc Haber <mh+usenetspam1118@zugschl.us> - 2025-12-18 11:19 +0100
Re: Python The Natural Philosopher <tnp@invalid.invalid> - 2025-12-18 12:36 +0000
csiph-web