Click here to Skip to main content
14,767,933 members

Welcome to the Lounge

   

For discussing anything related to a software developer's life but is not for programming questions. Got a programming question?

The Lounge is rated Safe For Work. If you're about to post something inappropriate for a shared office environment, then don't post it. No ads, no abuse, and no programming questions. Trolling, (political, climate, religious or whatever) will result in your account being removed.
 
GeneralRe: Programming Question Pin
_Maxxx_16-Jan-13 17:03
professional_Maxxx_16-Jan-13 17:03 
GeneralRe: Programming Question Pin
PIEBALDconsult16-Jan-13 18:11
professionalPIEBALDconsult16-Jan-13 18:11 
GeneralRe: Programming Question Pin
Shameel16-Jan-13 19:37
professionalShameel16-Jan-13 19:37 
GeneralRe: Programming Question Pin
kmoorevs17-Jan-13 12:28
Memberkmoorevs17-Jan-13 12:28 
GeneralRe: Programming Question Pin
Earl Truss18-Jan-13 7:55
MemberEarl Truss18-Jan-13 7:55 
GeneralRe: Programming Question Pin
User 58385216-Jan-13 17:07
MemberUser 58385216-Jan-13 17:07 
GeneralRe: Programming Question Pin
AspDotNetDev16-Jan-13 17:34
protectorAspDotNetDev16-Jan-13 17:34 
GeneralRe: Programming Question Pin
_Maxxx_16-Jan-13 17:51
professional_Maxxx_16-Jan-13 17:51 
I think comments are worth their weight so ling as they are written well - describing the business reasons not the technology (unless the tech is crafty, unusual or complex)

when I sit down to write a method, I start by calling it something

public double CalculateTax(double fine)
{
}


Then I comment it

///
/// Calculate the tax, taking into account the fine passed.
/// Requires that the tax rate is retrievable from the TaxService
///



Then I might write some test code just to get it building
///
/// Calculate the tax, taking into account the fine passed.
/// Requires that the tax rate is retrievable from the TaxService
///
public double CalculateTax(double fine)
{
    // TODO: Perform the tax calculation
    return 34567.89;
}


Then I start to flesh out the method by way of comments
///
/// Calculate the tax, taking into account the fine passed.
/// Requires that the tax rate is retrievable from the TaxService
///
public double CalculateTax(double fine)
{
    // Get the tax rate using the appropriate service
    // calculate the fine (I think it is just fine * tax rate but need to check with spec!)
}


Then, finally, I write the code
///
/// Calculate the tax, taking into account the fine passed.
/// Requires that the tax rate is retrievable from the TaxService
///
public double CalculateTax(double fine)
{
    // Get the tax rate using the appropriate service
    double taxRate = GetTaxRate();
    // calculate the fine 
    tax = taxRate * fine;

    return tax ;
}



That way, I can remember where I was if I get interrupted, the comments aren't an afterthought, they are a part of the process and, if I get hit by the Programmer bus, someone else should be able to see what I was doing.

Obv. the example is small and trivial, but that's how I work and I fail to understand the 'don't need comments' brigade.

What I do hate is/...

// Multiply the rate by the amount
return rate * amount;


which is simply a case of bad commenting in my book - it is not necessary to comment every step
MVVM# - See how I did MVVM my way
___________________________________________
Man, you're a god. - walterhevedeich 26/05/2011

.\\axxx
(That's an 'M')

GeneralRe: Programming Question Pin
AspDotNetDev16-Jan-13 18:03
protectorAspDotNetDev16-Jan-13 18:03 
GeneralRe: Programming Question Pin
_Maxxx_16-Jan-13 18:09
professional_Maxxx_16-Jan-13 18:09 
GeneralRe: Programming Question Pin
Mark_Wallace16-Jan-13 22:00
MemberMark_Wallace16-Jan-13 22:00 
GeneralRe: Programming Question Pin
Nagy Vilmos16-Jan-13 23:15
professionalNagy Vilmos16-Jan-13 23:15 
GeneralRe: Programming Question Pin
M Towler17-Jan-13 23:18
MemberM Towler17-Jan-13 23:18 
GeneralRe: Programming Question Pin
greldak17-Jan-13 23:32
Membergreldak17-Jan-13 23:32 
GeneralRe: Programming Question Pin
M Towler18-Jan-13 1:27
MemberM Towler18-Jan-13 1:27 
GeneralRe: Programming Question Pin
liordino18-Jan-13 2:29
Memberliordino18-Jan-13 2:29 
GeneralRe: Programming Question Pin
patbob18-Jan-13 6:53
Memberpatbob18-Jan-13 6:53 
GeneralRe: Programming Question Pin
JackDingler18-Jan-13 7:52
MemberJackDingler18-Jan-13 7:52 
GeneralRe: Programming Question Pin
CHill6018-Jan-13 2:28
mveCHill6018-Jan-13 2:28 
GeneralRe: Programming Question Pin
John Atten18-Jan-13 3:32
MemberJohn Atten18-Jan-13 3:32 
GeneralRe: Programming Question Pin
jrscherer18-Jan-13 5:08
Memberjrscherer18-Jan-13 5:08 
GeneralRe: Programming Question Pin
jharano18-Jan-13 5:46
Memberjharano18-Jan-13 5:46 
GeneralRe: Programming Question Pin
Florin Jurcovici18-Jan-13 20:06
MemberFlorin Jurcovici18-Jan-13 20:06 
GeneralRe: Programming Question Pin
Klaus-Werner Konrad24-Jan-13 2:56
MemberKlaus-Werner Konrad24-Jan-13 2:56 
GeneralRe: Programming Question Pin
_Maxxx_24-Jan-13 3:10
professional_Maxxx_24-Jan-13 3:10 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.