Skip to main content

NDoc, VS2005 & Sandcastle (updated)

We're in the process of moving to Visual Studio Team System and porting our various unit testing, automated builds etc and one of the tools I'm surprised is missing from VSTS is an NDoc replacement.

I'm all for open source/third party tools and MSFT has done such a thorough job on the unit testing side I thought they might have done something in the code documentation area too (in all probability they spent too much time on the testing stuff and didn't have any left).

Anyway, I started to research NDoc and VSTS and found that the project seems to have stalled and there wasn't an official version with 2005 support (Generics) - a private beta is floating about though apparently. After catching a thread on a discussion forum I picked up on this post about "Sandcastle" - the code name for the MSFT internal documentation tool. Expect a release sometime this year then ;-)

In the meantime there is a interim version of NDoc that does support 2005 and you can find it here. I downloaded and compiled the source and it works perfectly - there may be an issue with the binaries release and a missing stylesheet so best to just get source and recompile.

More on Sandcastle here

Update 27 July '06
(via Larkware 935) "NDoc2.0 is dead" - the main developer on NDoc, Kevin Downs has pulled out of the project - read this for the issues and reasoning behind this. I fully understand and respect Kevins decision on this one.

Also the NDoc 2005 version mentioned above does run but seems to crash a lot...not investigated why yet though - I'll update again if I find anything worth mentioning.

Comments

Popular posts from this blog

Walk-Thru: Using Wolfpack to automatically deploy and smoke test your system

First, some history... The advent of NuGet has revolutionised many many aspects of the .Net ecosystem; MyGet, Chocolatey & OctopusDeploy to name a few solutions building upon its success bring even more features to the table.

I also spotted that NuGet could solve a problem I was having with my OSS System Monitoring software Wolfpack; essentially this is a core application framework that uses plugins for extension (Wolfpack Contrib) but how to unify, standardise and streamline how these plugins are made available? NuGet to the rescue again - I wrapped the NuGet infrastructure (I deem NuGet to be so ubiquitous and stable that is has transcended into the software "infrastrucuture" hall of fame) with a new OSS project called Sidewinder. Sidewinder allows me to wrap all my little extension and plugins in NuGet packages and deploy them directly from the Wolfpack application - it even allows me to issue a new version of Wolfpack and have Wolfpack update itself, sweet huh?

Abou…

Resharper add-in idea - highlight IDisposable vars

[Update 18th July 2013]
@RobGibbens and Greg Hurlman picked up on this - Rob pointed out that there is an FxCop rule that can do this and Greg suggested a Visual Studio extension. I've had a quick look at the Visual Studio options and it looks like an "Editor Extension" is a good fit....hmmm, Project New, click...doh...dammit I really don't have time for this but it looks a fun little diversion! I'll update here if I get anything working.

[Original Post]
Had an interesting idea for a Visual Studio Resharper add-in the other day but don't have the time to implement it so thought I would put it out there...it might already exist (and hopefully someone can point me in the right direction) or someone will build it (Darren Voisey where are you?!).

The idea is very simple really - when you have a variable for an object that implements IDisposable it gets highlighted or a tell-tale is displayed to let you know it should be disposed or should be wrapped in a using sta…

Geckoboard Countdown Widget v2

v2 is here, now with added colours! This time using the RAG Numbers widget to display your date countdown - as you get nearer the date the number will change from green to amber then red.

The new url is: http://geckocountdown.appspot.com/rag/?date=2010-12-25&tz=0&msg=Days+to+Xmas!
Note 1: notice the new /rag/ path and the msg querystring param.
Note 2: the original v1 url still works


To use this on your Geckoboard add a new "Custom Widget/RAG Numbers" widget. By default the number will turn amber at 10 or less days to go and red at 3 or less days to go however you can change these with the querystring (see below).


Required querystring params
date: "yyyy-mm-dd" format, this is the target date to countdown totz: timezone offset in hours from GMT that you are in. Can be negative if you are behind GMT
Optional querystring params
msg: the label that appears next to the number of days (remember to encode spaces as +). The default is "Days Remaining" if you…