Click here to Skip to main content
12,621,432 members (29,787 online)

Welcome to the Lounge

   

For discussing anything related to a software developer's life. Technical discussions are encouraged, but click here to ask your programming questions.

The Lounge is rated PG. If you're about to post something you wouldn't want your kid sister to read then don't post it. No flame wars, no abusive conduct, no programming questions and please don't post ads.
 
GeneralRe: Programming Question Pin
Nagy Vilmos16-Jan-13 23:15
memberNagy 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 
I feel that level of commenting or descriptive naming would be breaking encapsulation, by exposing the implementation of GetTaxRate. I will go further and say that it would be repeating some of the documentation of GetTaxRate, so fails DRY. This piece of code is simply doing a calculation, so it calls a function to get the rate. It does not really need to have knowledge of where the rate came from to do its task, so it is best not to give it this knowledge. Having minimal information in this function means it will not become out of date when the implementation of GetTaxRate changes, such as to add a local cache of the value obtained from the service, using a database of rates or some other alteration.

In summary, what I am really saying is that comments of this type raise the cost of maintenance, as each later change will have to find and change multiple comments in addition to the code itself, or else risk misleading future maintainers.
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
memberCHill6018-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 

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.


Advertise | Privacy | Mobile
Web02 | 2.8.161128.1 | Last Updated 2 Dec 2016
Copyright © CodeProject, 1999-2016
All Rights Reserved. Terms of Service
Layout: fixed | fluid