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

"If a jr. dev is going to be required to maintain the code..." In my experience it's better to just assume that everyone reading your comments is a jr. dev. If they aren't then they wouldn't be reading your comments. Even if they are not jr. and are still reading your comments, jargon and assumptions lead to miscommunication. Finally...most devs, like every other field known to man, get through life not really giving a damn and never really get a whole lot better than "jr".

Edward Strange
– Edward Strange

2012-05-14 07:07:20 +00:00
Commented May 14, 2012 at 7:07

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 »