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.

2

The comment trick works for me, too. Among other reasons, I always include a comment block above any non-trivial subroutines as a kind of final sanity check. If I find myself having to do a lot of explaining (or even, on occasion, apologizing for) convoluted or obtuse sections of code or weird input params or whatever, that's a warning sign I may need to rethink the solution a bit.

BlairHippo
– BlairHippo

2011-07-11 14:41:39 +00:00
Commented Jul 11, 2011 at 14:41
@BlairHippo HA! "final sanity check" I like that.

Philip
– Philip

2011-07-11 14:52:06 +00:00
Commented Jul 11, 2011 at 14:52

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 »