Edit - Software Engineering Stack Exchange

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.

Thanks for the mention of "comment-driven development", it seems quite useful here and I didn't read about that yet.

WarpEnterprises
– WarpEnterprises

2012-09-13 05:44:26 +00:00
Commented Sep 13, 2012 at 5:44
+1: I'm a little leery of "comment-driven development" because I firmly agree with your belief that code should be self-documenting; but overall, a very solid answer.

Jim G.
– Jim G.

2012-09-15 03:11:31 +00:00
Commented Sep 15, 2012 at 3:11
"CDD" is less a set of rules defining how it should be done, and more a way to write a "first draft" in pseudocode or structured English within the IDE, that paves the way for real code later. When the real code is written you can keep or discard comments as you see fit.

KeithS
– KeithS

2012-09-18 15:19:05 +00:00
Commented Sep 18, 2012 at 15:19

Add a comment |

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

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>

formatting help »
answering help »