|
Can any one suggest what is the best way to write good code that is understandable without a single line of comments?
Started by pang on
, 21 posts
by 21 people.
Answer Snippets (Read the full thread at stackoverflow):
Comments don't get checked by the compiler so to be very detailed in your....
Her approach really think comments are a good idea in most cases.
I was in college tell me that any good code should never need any comments.
|
|
I talk about source-code-comments, that explains what happens on the next lines of code, not Javadoc/Doxygen-comments (that comment on the interface).
Comments can make your intention for the code clearer, but on the other hand they could be redundant...
Started by Mnementh on
, 11 posts
by 11 people.
Answer Snippets (Read the full thread at stackoverflow):
Source code comments unless meant to....
Of course, comments are never a replacement for good quality code .
Try seeing on.
Good quality comment is always a good thing.
Not be expressed by source like the "why".
|
|
I've always hated comments that fill half the screen with asterisks just to tell you that the function returns a string, I never read those comments.
However, I do read comments that describe why something is done and how it's done (usually the single...
Started by Laith J on
, 11 posts
by 11 people.
Answer Snippets (Read the full thread at stackoverflow):
This, I think, is a good form of comment, because it has both a human- and machine-readable format Doxygen comments....
Saying "loop.
But a good metric to use is:
Comment why you're doing something, not how you're doing it.
|
Ask your Facebook Friends
|
Hi, I'm looking for some good examples of .NET XML-style source code comments and all the various tags available in use. Where can I find some good examples?
Started by Nosrama on
, 4 posts
by 4 people.
Answer Snippets (Read the full thread at stackoverflow):
Helpful links:
XML Comments Let You Build Documentation Directly From Your Visual Tags Used for Documentation Comments C# and XML Source Code Documentation.
To document code.
|
|
English is not my mother tongue. However, I have to write comments in english. I want to improve my "comment english" by studying a piece of code which is commented in a good english. Please recommend an open source project which contains a lot of meaningful...
Started by danatel on
, 8 posts
by 8 people.
Answer Snippets (Read the full thread at stackoverflow):
Comments are often not even correct English and good projects will not have too many comments anyway, hence actually learn quite....
I don't think comments are a good place to learn, even if you have to emulate this style.
|
|
I find the xml doc comments for C# or VB.NET very hard to read. Is there a decent alternative (that still provides the benefits of documenting code for intellisense, doc generation, etc.)?
Started by Pete on
, 5 posts
by 5 people.
Answer Snippets (Read the full thread at stackoverflow):
I started with the one.
Which it does mine) you could add a stylesheet to the xml comments file.
|
|
I'm considering using PostgreSQL's Ltree module in my application to help with threaded comments. I've been eying it for a while to use for threaded comments. I figure it would help with cases where you need to update a node and its children, like when...
Started by Cory R. King on
, 4 posts
by 4 people.
Answer Snippets (Read the full thread at stackoverflow):
If you're modifying old code, you may want to wait until 8.4 is released, as then you won't have to worry about... .
RECURSIVE expressions.
Version 8.4 of PostgreSQL will be bringing Common Table Expressions functionality into the core with WITH and WITH.. .
|
|
Hi.
Looking for comments for an open source solution for doing version control/project mgmt..
The project is initially a couple of dev guys.. but it will grow to a few more web designers.. and over time, there may be 100 developers adding their scripts...
Started by tom smith on
, 3 posts
by 3 people.
Answer Snippets (Read the full thread at stackoverflow):
Good luck to you..
Really easy to use and just hear overwhelmingly good things about PI when I interview their clients and Project.
|
|
I want to add the ability to submit, moderate and display comments on an existing set of websites. Surely there's already a bunch of open source components that can handle the following:
Comment submission Markup validation Private comment moderation ...
Started by Martin Gladdish on
, 4 posts
by 4 people.
Answer Snippets (Read the full thread at stackoverflow):
From the Google Code description:
Demi Sauce is an application javascript into your app (like ... .
Check out Demi Sauce.
Well, I think the problem here is that to comment, one really needs to comment on Something, so comments to it.
|
|
I was wondering how people normally separate out the multiple comments in a single commit. Stars? Commas? Separate lines? Just wondering what you find to be the best.
I'm using this now when I add comments via Emacs, but not sure I like it:
Added error...
Started by chuboy on
, 5 posts
by 5 people.
Answer Snippets (Read the full thread at stackoverflow):
I strive not to commit changes which require too many comments.
On a merge back into your into one merge.
Of what each modification is and your commit comments will give you the why.
|
