Collin Funk wrote:
> #========================
> # Define GLImport class
> #========================
> class GLImport:
> ....
>
> But when searching for a class in Python you can simply look up
> '^class NAME:' since whitespace matters in that language. No need for
> the comment in my opinion.
I find these comments useful, in particular in files that contains
several classes, such as GLFileSystem.py.
This is because I apparently work differently from you: When I open
a source code file:
- I do so in a window with at least 50 lines, then
- I scroll over the entire file using the scroll bar, in order to
grasp its structure from the comments and separating comment lines.
- Then only I start to focus on a particular section.
I never use "grep -n '^class ' *.py" to understand where the classes
are defined.
Also, separator lines without comments help sometimes, e.g. in lib/argp-help.c.
Bruno
