View Single Post
  #22  
04-20-2014, 07:21 AM
RoryF's Avatar
RoryF
aka OddMan360
 
: Jul 2009
: 42 Wallaby Way
: 1,485
Blog Entries: 17
Rep Power: 17
RoryF  (860)RoryF  (860)RoryF  (860)RoryF  (860)RoryF  (860)RoryF  (860)RoryF  (860)

Well, I've got to make sure that the stuff that's in the code is as understandable as possible. The way I do it is to simply name anything the best I can, and if I can't give it a good name (eg one's that would be annoying to type out), I'll stick a comment above it to explain it. Especially in long winded parts I put a lot of comments in essentially step by step, if it needs it of course.

Visual Studio is pretty good in that it takes two seconds to add the descriptions of methods and things with ///. I know in Java the equivalent is making a JavaDoc and referencing it but that takes time (or at least I haven't used Java enough to really know).
__________________
>> oddmatics.co.uk <<
there's stuff there, totally cool stuff, really!

Reply With Quote