Comments on: Skeleton Classes http://warpspire.com/tipsresources/interface-scripting/skeleton-classes/ my god, it's full of stars Sun, 06 Jul 2008 19:33:07 +0000 http://wordpress.org/?v=2.5.1 By: Shadowfiend http://warpspire.com/tipsresources/interface-scripting/skeleton-classes/#comment-37801 Shadowfiend Thu, 09 Aug 2007 15:52:52 +0000 http://warpspire.com/tipsresources/interface-scripting/skeleton-classes/#comment-37801 <p>Caleb's point is an excellent one, and in fact I'd argue it's probably the biggest advantage of skeleton classes. By documenting beforehand, you can have a clear outline of what your method is supposed to do before you even write it, so that if you have to expand what it does, you can critically look at your original intentions and decide whether another method is needed.</p> <p>Moreover, bear in mind that skeleton classes are basically the level right above the UML class diagram -- the difference being that you're looking at it in code rather than as a drawing. Test-first strategies, by the way, bring some similar advantages, namely in allowing you to exercise your API before you write it so you get a better feel for how it will work.</p> Caleb’s point is an excellent one, and in fact I’d argue it’s probably the biggest advantage of skeleton classes. By documenting beforehand, you can have a clear outline of what your method is supposed to do before you even write it, so that if you have to expand what it does, you can critically look at your original intentions and decide whether another method is needed.

Moreover, bear in mind that skeleton classes are basically the level right above the UML class diagram — the difference being that you’re looking at it in code rather than as a drawing. Test-first strategies, by the way, bring some similar advantages, namely in allowing you to exercise your API before you write it so you get a better feel for how it will work.

]]> By: Caleb http://warpspire.com/tipsresources/interface-scripting/skeleton-classes/#comment-37656 Caleb Wed, 08 Aug 2007 16:19:57 +0000 http://warpspire.com/tipsresources/interface-scripting/skeleton-classes/#comment-37656 <p>I would suggest, when writing skeletons, that you also take the opportunity to heavily document the functions, even if it's just with comments above the signature. It will keep the code readable and keep you from forgetting exactly what the function needs to take care of.</p> I would suggest, when writing skeletons, that you also take the opportunity to heavily document the functions, even if it’s just with comments above the signature. It will keep the code readable and keep you from forgetting exactly what the function needs to take care of.

]]> By: Noah Everett http://warpspire.com/tipsresources/interface-scripting/skeleton-classes/#comment-37649 Noah Everett Wed, 08 Aug 2007 15:16:30 +0000 http://warpspire.com/tipsresources/interface-scripting/skeleton-classes/#comment-37649 <p>Very nifty. Also using the same naming structure for all your classes helps in the long run so when you are up to your knees in classes and you need to figure out what the "getter/setter" for this specific object is without going back to the source file itself.</p> Very nifty. Also using the same naming structure for all your classes helps in the long run so when you are up to your knees in classes and you need to figure out what the “getter/setter” for this specific object is without going back to the source file itself.

]]>