Skip to main content

All Questions

11 votes
2 answers
10k views

Asterisks in Multi-line comments

Using Visual Studio 2012 with C#, when I write multi-line comments, VS automatically begins each line with an asterisk, like this: /* * * */ I was just curious if this was the case in programming ...
kettlecrab's user avatar
22 votes
4 answers
10k views

Is the "Gets or sets .." necessary in XML documentation of properties?

I am looking for a recommendation of a best practice for XML comments in C#. When you create a property, it seems like that the expected XML documentation has the following form: /// <summary> /...
Tomas's user avatar
  • 265
13 votes
2 answers
5k views

What is the best approach for inline code comments?

We are doing some refactoring to a 20 years old legacy codebase, and I'm having a discussion with my colleague about the comments format in the code (plsql, java). There is no a default format for ...
Diego Alvarez's user avatar