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.

Required fields*

Rev

1

Whilst this doesn't directly answer OP, this is really good advice, and for me the number 1 reason to write code doc comments for every function and property. In fact, I encourage my devs to write the comment first, with an empty prototype, then unit tests to enforce the logic explained in the comment, then the function body itself. At all review points, we accept the comment as the gospel expressing the original intent, from outside the function, the comment and the prototype are all we have to go on. As for in-line comments, the same rules apply, comment should express intent and why.

Chris Schaller
– Chris Schaller

2020-02-16 12:13:42 +00:00
Commented Feb 16, 2020 at 12:13

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 »