You are not logged in. Your edit will be placed in a queue until it is peer reviewed.
We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.
- 7I know it is not enough.Florian F– Florian F2014-09-01 11:47:54 +00:00Commented Sep 1, 2014 at 11:47
- 2Since when? Apparently, you already know the answer to that. "Well designed code with good names is more than enough in the vast majority of cases." So, it's probably not enough in a minority of cases, which is exact what the asker is asking.Azhdeen– Azhdeen2014-09-02 20:01:51 +00:00Commented Sep 2, 2014 at 20:01
- 3I am ever trying to decipher other peoples' code whom I wish had added some comments more than once every two years.Ogre Psalm33– Ogre Psalm332014-09-04 20:15:11 +00:00Commented Sep 4, 2014 at 20:15
- @OgrePsalm33 - Do they have small methods and use good names? Bad code is bad, regardless of comments.Telastyn– Telastyn2014-09-04 20:26:45 +00:00Commented Sep 4, 2014 at 20:26
- 2@Telastyn Unfortunately, when working on a large code base, "small" methods and "good" names are subjective to each developer (so is a good comment, for that matter). A developer writing Flarbigan graphical processing algorithm code for 7 years, can write something perfectly clear to him and similar developers, but would be cryptic to the new guy who spent the last 4 years developing Perbian grid infrastructure code. Then, 2 weeks later, the Flarbigan expert quits.Ogre Psalm33– Ogre Psalm332014-09-04 21:04:23 +00:00Commented Sep 4, 2014 at 21:04
| Show 3 more comments
How to Edit
- Correct minor typos or mistakes
- Clarify meaning without changing it
- Add related resources or links
- Always respect the author’s intent
- Don’t use edits to reply to the author
How to Format
- create code fences with backticks ` or tildes ~ ```
like so
``` - add language identifier to highlight code ```python
def function(foo):
print(foo)
``` - put returns between paragraphs
- for linebreak add 2 spaces at end
- _italic_ or **bold**
- indent code by 4 spaces
- backtick escapes
`like _so_` - quote by placing > at start of line
- to make links (use https whenever possible) <https://example.com>[example](https://example.com)<a href="https://example.com">example</a>
How to Tag
A tag is a keyword or label that categorizes your question with other, similar questions. Choose one or more (up to 5) tags that will help answerers to find and interpret your question.
- complete the sentence: my question is about...
- use tags that describe things or concepts that are essential, not incidental to your question
- favor using existing popular tags
- read the descriptions that appear below the tag
If your question is primarily about a topic for which you can't find a tag:
- combine multiple words into single-words with hyphens (e.g. design-patterns), up to a maximum of 35 characters
- creating new tags is a privilege; if you can't yet create a tag you need, then post this question without it, then ask the community to create it for you