Documentation: It's my Cilice

December 6, 2007 17:00

I've neglected SubSonic for far too long, and it's time for me to wear my hair shirt. For me, this means making a concerted effort on something that ranks with being forced to watch holiday jewelry ads, Clockwork Orange style, on my list of least favorite things to do. However, it's the best way to pay my penance, and bring some substance to Rob's recent assertion. :)

I've started the process with Revision 217, which is, for the most part a code formatting clean up. Given the fact that properly documenting the code base requires touching almost every file, I'm trying to do frequent check-ins so as to avoid code merge hell.

The next pass is to get GhostDoc stubs in throughout the code base, (with whatever goofy auto generated comments it may produce) so that the overall comment and line counts are stabilized as quickly as possible and the current generated documentation stops looking like one big sea of red. Finally, I'll be doing a pass over the entire collection ensuring that everything is completely and accurately annotated.

To stay sane, I'm still be attacking work items in the process, so make sure that any outstanding bugs you've discovered have made it onto CodePlex, to be included in our well-documented 2.0.4 release. Sorry, no date commitment yet... 


6 Comments
Actions: E-mail | Permalink | Comment RSSRSS comment feed

Related posts

Comments

December 6. 2007 19:02

John S.

don't take this the wrong way, but...i missed you. Smile

John S.

December 7. 2007 05:06

Eric, once you get the ghost-doc stubs into the project it would be well worth hitting the code base up with sand castle.

Good to see you getting this effort underway.

Dave S.

December 7. 2007 11:29

Eric

Already done... I got all the stubs in last night and set up a help builder project (which I've added to source control). Lots of generic comments, but it's starting to look a bit more real...

The latest Sandcastle output can now be found at http://subsonichelp.com

Eric

December 7. 2007 19:57

Devaid

Really hope subsonic continues, I must admint I did get worried that the project had "died".

Devaid

December 8. 2007 01:56

Jason Kealey

Great to see you back in action Smile

Jason Kealey

December 15. 2007 18:02

Dave Neeley

I need to get a little more balance in my life. Cilice? That's the vocabulary of an educated, one might dare say "enlightened", individual. All code and no enlightenment makes Dave a dull boy. ;)

Dave Neeley

Comments are closed