Skip to main content
Software Engineering

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*

2
  • Thanks. It is hard to figure out what lines are and are not worth commenting on, I feel as though if I added to many comments the actual code page would be 50% code and 50% comments. Your advice will help me continuing developing this project further. Commented Jun 14, 2017 at 21:07
  • 1
    @Bender In my answer I was talking primarily about class member documentation. In code bodies you will often have several blocks that represent steps in the logic. You could briefly comment each block and the comments together should tell the method's story. Ideally you would start by writing these comments in an empty code body, thus setting the stage for your implementation and then insert the code blocks. Commented Jun 14, 2017 at 21:36