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.

5

I had a teacher who said that ideally code should be written "so that someone who knew nothing about programming (like maybe your mother) could understand it." Unfortunately that is an ideal, but maybe we should include our moms in code reviews anyway!

Michael K
– Michael K

2012-05-04 12:35:14 +00:00
Commented May 4, 2012 at 12:35
+1 for "but if you come to a single line of code where you have to add something new you then have to jump all over the place to work out what you need to add/change"

quickly_now
– quickly_now

2012-05-05 05:26:32 +00:00
Commented May 5, 2012 at 5:26

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 »