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.

@karianna - So you are suggesting to leave everything except class description to source control repository; but, will it be tedious to view it from repository log each time. And what if I want to create documentation file (like .chm or sandcastle)?
– Sandeep Kumar M
Commented Oct 6, 2010 at 13:05
@Sandy You should be able to put in certain keywords in your code comment header that your source control repository will update each time you check in. It depends on what language you are coding in and what source control repo you are using. What are you using? :)
– Martijn Verburg
Commented Oct 6, 2010 at 13:09
@karianna - I'm using Subversion; hope discussing little tech/programming won't make this closed! :-) Please let me know whether I need to post a question in SO asking how to merge log comment to particular class? :-)
– Sandeep Kumar M
Commented Oct 6, 2010 at 13:15
You can use $Id: $ and $URL: $, the : might be optional, I forget. Hopefully the SO overlords won't slay us for our blasphemy
– Martijn Verburg
Commented Oct 6, 2010 at 13:24

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 »