Putting comments in code are ok as long as it's done in moderation: Too little comment(s), fellow developers/managers would ask/clarify what your code does. Too much comment(s) would get in the way in reading the source code. :)
More often than not, if the code has been written to be descriptive enough, then there is no need to put comments (self-documenting). More on this here: http://www.devtopics.com/13-tips-to-comment-your-code/ Cheers! Benj On Nov 25, 5:13 pm, Processor-Dev1l <[email protected]> wrote: > My first language was C. When I started learning it I used only > notepad and compiler. > Tabs were really important for the code readability and some comments > made the code also more readable. > But some ppl didn't like it so first IDE editors were created to > highlight parts of the code. > c# went even far and also created so called regions for even better > readability. > > Why am I writing this? > Well, I just sent my code for review to my current client and I got it > back with words: "It is not commented enough". > They want me to comment every stupid line of the code (even xml > comments), so it should look like this: > /// <summary> //start of xml comment > /// something to work with //content of xml comment > /// </summary> //end of xml comment > /// <param name="someData"></param> //parameter name of xml > comment > public static int someFunction(int someData) //declaration of > method > someFunction > { //start of someFunction method > return int someData*10; //returning product of > someData variable > value and 10 > } //end of someFunction method > > My question is: IS THIS READABLE??? I THINK NOT!!!
