Thoughts On Comments In Team Code

Continuous improvement turns good to great. Continuous tinkering can lead to inconsistent behavior and headaches. - IKE [more]

		Chief Delphi > Technical > Programming
Thoughts On Comments In Team Code

Thread Tools

Rating:

Display Modes

#10

24-02-2016, 11:44

Caleb Sykes Caleb Sykes is offline

Registered User

FRC #4536 (MinuteBots)

Team Role: Mentor

Join Date: Feb 2011

Rookie Year: 2009

Location: St. Paul, Minnesota

Posts: 1,051

Caleb Sykes has a reputation beyond repute

Re: Thoughts On Comments In Team Code

We use javadocs as much as we can. In addition, we usually add comments explicitly stating units of variables. Besides that, we occasionally add in comments explaining what a single line does, but this is rare.

Putting a comment on every single line is a waste of human resources and just clutters the code.

« Previous Thread | Portal | Next Thread »

Thread Tools
Show Printable Version Email this Page
Display Modes	Rate This Thread
Switch to Linear Mode Switch to Hybrid Mode Threaded Mode	Rate This Thread:

Posting Rules
You may not post new threads You may not post replies You may not post attachments You may not edit your posts vB code is On Smilies are On [IMG] code is On HTML code is Off

Forum Jump

All times are GMT -5. The time now is 17:45.

The Chief Delphi Forums are sponsored by Innovation First International, Inc.