Rory Primrose

Skip to content
Skip to menu

<< Using GhostDoc to document unit test methods | GhostDoc feature in hiding - Roland already has the goods! >>

Mar 18 2009

Using GhostDoc to document unit test classes

Category: .Net | Applications — Rory Primrose @ 06:47

To follow up on my last post about documenting unit test methods with GhostDoc, a similar concept can be applied to documenting unit test classes.

Add a custom rule under the Classes section in the GhostDoc configuration dialog.

I have used the name "Matches unit test class" and identified type names that end with "Tests". I have entered the summary documentation with the following value:

The $(TypeName.ShortNameAsSee)
class is used to test the <see cref="$(TypeName.Words.Verbatim.ExceptLast)" /> class.$(End)

Edit Rule dialog

This produces much nicer documentation that the default documentation provided by Visual Studio.

Tags:

ce85c69e-a7ff-4d77-ab72-7132c7060356|0|.0

Comments (1)

Using GhostDoc to document unit test methodsGhostDoc is one of the coolest tools around for [VS]. Sometimes it needs a little help though and un...MStest unit test adapter fails on CorrelationManager logical operation that isn't stoppedI have been writing lots of unit tests for my Toolkit project on CodePlex. The most recent work is a...Mocking IUnityContainer and avoiding BadImageFormatExceptionThere is an issue with mocking IUnityContainer from RhinoMocks. A BadImageFormatException is thrown ...

Comments (1) -

007b2b

says:
Sunday, March 22, 2009 at 11:09 PM

This produces much nicer documentation that the default documentation provided by Visual Studio.

Pingbacks and trackbacks (1)+

Add comment

Name* Required Please choose another name

E-mail*

Country Country flag

b i u quote

Comment
Preview

Notify me when new comments are added

Using GhostDoc to document unit test classes