DotNetKicks.com - Stories tagged with documentation

Introducing Code Rocket

Tue, 22 Jun 2010 07:54:52 GMT

This article introduces you to Code Rocket's main features. Code Rocket is a pseudocode and flowchart design and visualization tool for Visual Studio (and Eclipse). It gives you on demand access to the pseudocode and flowchart views of your methods and always keeps the design in sync with the code. The content was the basis of a presentation given at TechMeetup Aberdeen. You can download the slides and sample code for the example.

Distinguish between overloaded methods in XML-Comments

Tue, 28 Jul 2009 10:52:48 GMT

This posting shows how to distinguish between overloaded methods in XML-Comments.

jQuery.growl Documentation

Tue, 21 Oct 2008 08:53:19 GMT

jQuery.growl is a cool open-source plugin for a cool open-source javascript library. Some just needed to tell people how to used it.

Documents 2.0 - Consumable Documents

Wed, 03 Sep 2008 14:46:02 GMT

Sidar discussing the need for more agile documents in business environments.

SHFB - A NDoc like GUI for Sandcastle

Wed, 23 Jan 2008 16:15:08 GMT

Sandcastle Help File Builder makes building your code documentation with Sandcastle easy. Looks like NDoc and even has the ability to import NDoc projects. No one should try to use Sandcastle without this little but powerful tool.

Automate creation of a MSDN-style documentation website

Mon, 21 Jan 2008 21:57:40 GMT

I'm putting up a guide to configuring Team Build to automatically generate a documentation website a la MSDN using Sandcastle and the Sandcastle Help File Builder. The idea is that a daily build generates a documentation website from code comments, which is then immediately published to a website for viewing. Cool stuff.

GhostDoc 2.1.1 Release: For programmers who hate writing documentation

Wed, 03 Oct 2007 22:16:11 GMT

Unlike nDoc or Sandcastle, this tool doesn't generate the end-result documentation, rather, it's a VS add-in that _automatically_ writes the XML documentation in your C# code! What it generates is based upon a set of editable rules.

Sandcastle - September 2007 Community Technology Preview (CTP)

Thu, 04 Oct 2007 23:46:02 GMT

Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments. Sandcastle has the following key features: Works with or without authored comments, Supports Generics and .NET Framework 2.0, Sandcastle has 2 main components (MrefBuilder and Build Assembler), MrefBuilder generates reflection xml file for Build Assembler, Build Assembler includes syntax generation, transformation, Sandcastle is used internally to build .Net Framework documentation.

GhostDoc 2.1.0 Released

Thu, 28 Jun 2007 12:31:01 GMT

Another version of GhostDoc, a VS-Plugin making the sourcecode documentation as easy as ctrl+shift+D, has been released on Jun 24 2007 by Roland Weigelt. He added VB.Net support and better handling of event documentation.

Welcome!

Fri, 01 Jun 2007 14:46:01 GMT

SubSonic documentation site

Visual Studio Plugin GhostDoc 2.0.0 Released

Wed, 09 May 2007 13:16:02 GMT

Roland Weigelt released version 2.0 of his XML-Comment generator plugin for visual studio. It now runs under Vista and he added support for Orcas. All changes can be found in the changelog on his blog. For downloads visit http://www.roland-weigelt.de/ghostdoc/ .

Documentation for Telepathic Developers

Tue, 03 Apr 2007 16:34:19 GMT

Code insight started as a helpful utility but has now almost completely replaced API documentation. This puts a lot more pressure on the API and it's authors - not only should it cover all required functionality, but it must also be intuitive to use. We must acknowledge and understand the effects of those tools in order to make our APIs better.

C++/CLI Documentor

Fri, 02 Feb 2007 18:46:01 GMT

Source Code Documentation for C++/CLI in Visual Studio 2005 is often an annoying thing to do. C++/CLI Documentor implements an Add-in for Visual Studio 2005 that automatically generates the necessary XML comments.

Announcing December 2006 Sandcastle CTP

Tue, 12 Dec 2006 21:01:01 GMT

The December 2006 CTP version for Sandcastle is now available for download. Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments. You can read about the latest changes and find the download link on the official blog.

Graphical userinterface for Microsoft's Sandcastle

Thu, 17 Aug 2006 18:31:04 GMT

I have been using Microsofts Sandcastle for some time now and it's xml-schemas have driven me nuts.... so I made a small userinterface for Sandcastle. The program is freeware and includes the following features: - Support for online MSDN-links. - Documenting of specified namespaces instead of entire assemblies. - Multiple outputtypes (website and/or .CHM-file). - Custom copyright line. - Custom company logo. - Custom product information. View my website for more information and a download-link: http://www.inchl.nl View generated output using SandcastleGUI: http://www.inchl.nl/help/ Kind regards, Stephan Smetsers stephansmetsers@hotmail.com