School Assignment? Project Due Tomorrow? Chat LIVE With A Programming Expert!

Programming Help

Web Development



What's Here?

  • Members: 300,427
  • Replies: 826,037
  • Topics: 137,458
  • Snippets: 4,419
  • Tutorials: 1,148
  • Total Online: 1,492
  • Members: 81
  • Guests: 1,411

Welcome to Dream.In.Code
Become an Expert!

Join 300,427 Programmers for FREE! Get instant access to thousands of experts, tutorials, code snippets, and more! There are 1,492 people online right now. Registration is fast and FREE... Join Now!




Comment Preference

 

Comment Preference
cgomez82

30 Jun, 2009 - 02:41 PM
Post #1

New D.I.C Head
*

Joined: 16 Jun, 2009
Posts: 5


My Contributions
When coding, what is your preferred style for commenting. Lowercase, title case, uppercase...? And, why?

User is offlineProfile CardPM
+Quote Post


crazyjugglerdrummer

RE: Comment Preference

30 Jun, 2009 - 03:20 PM
Post #2

YOUR AD HERE
Group Icon

Joined: 7 Jan, 2009
Posts: 677



Thanked: 94 times
Dream Kudos: 425
My Contributions
I just primarily make sure that the comment is as helpful as possible to any reading/trying to understand the code. I suppose if I had a huge project I might consider a commenting style, but you can kind of just do each one individually without trouble IMHO.
User is offlineProfile CardPM
+Quote Post

AdaHacker

RE: Comment Preference

30 Jun, 2009 - 06:06 PM
Post #3

D.I.C Regular
***

Joined: 17 Jun, 2008
Posts: 378



Thanked: 83 times
My Contributions
QUOTE(cgomez82 @ 30 Jun, 2009 - 04:41 PM) *
When coding, what is your preferred style for commenting. Lowercase, title case, uppercase...? And, why?

Are you sure you mean comments and not, say, variable names? Becuase I'm not really sure what you're getting at. I can't even begin to fathom why anyone would want to have a convention for the capitalization of comments. You write comments as regular English sentences, or fragments thereof. What possible benefit would you derive from using non-standard capitalization?
User is offlineProfile CardPM
+Quote Post

firebolt

RE: Comment Preference

30 Jun, 2009 - 09:42 PM
Post #4

D.I.C Lover
Group Icon

Joined: 20 Feb, 2009
Posts: 5,463



Thanked: 75 times
Dream Kudos: 1675
My Contributions
Ahh... default font, lower case and default size.smile.gif
User is offlineProfile CardPM
+Quote Post

Core

RE: Comment Preference

1 Jul, 2009 - 01:15 AM
Post #5

Den The Developer
Group Icon

Joined: 8 Dec, 2008
Posts: 2,944



Thanked: 214 times
Dream Kudos: 900
Expert In: C#, VB.NET, .NET Framework

My Contributions
I usually comment the same way I write any other sentences. In this way those are clear and concise. Also, sometimes I minimize the number of comments by using clear variable, class and function names, therefore the need for a comment is equal to zero.
User is offlineProfile CardPM
+Quote Post

Raynes

RE: Comment Preference

1 Jul, 2009 - 06:43 AM
Post #6

Resident Witch. No, really.
Group Icon

Joined: 5 Jan, 2009
Posts: 900



Thanked: 11 times
Dream Kudos: 225
My Contributions
I just write sentences explaining the code. The fewer sentences I can use to explain it the better.
User is offlineProfile CardPM
+Quote Post

Fast ReplyReply to this topicStart new topic

Time is now: 11/8/09 12:25AM
Invision Power Board v2.1.7 © 2009  IPS, Inc.
Licensed to: MediaGroup1

Live Help!

Be Social

Dream.In.Code RSS Feed Dream.In.Code LinkedIn Group Follow Us On Twitter Fan Us On Facebook

Tutorials

Programming

Web Development

Reference Sheets

Code Snippets

DIC Chatroom

Bye Bye Ads

Monthly Drawing

Thumb Drive

Top Contributors

Top 10 Kudos This Month