About Jolt.NET Libraries

Inspired by the Boost C++ libraries, Jolt.NET aims to complement the .NET Base Class Library (BCL) with algorithms, data structures, and general productivity tools. It is the hope of the authors that the features of Jolt.NET will one day be part of, or represented in the BCL and the .NET Framework.

Xml Doc Comment Transformations

The Jolt.Testing library now supports creating XML doc comments for a generated proxy and interface type, as well as aggregating such XML for a generated assembly.  The code is made available by revision 18785, and usage examples are posted in the library documentation.

The implementation of this feature utilizes the XmlDocCommentReader class detailed in my previous post, and also provides configuration to turn the feature on and off.  When creating the XML doc comments for the new types, a simple transformation is performed on the existing XML, replacing the type name of the real subject type with that of the proxy or interface.  For simplicity, all other XML data  participating in the transformation is left untouched.  The following snippet depicts this process.





mscorlib




Provides static methods for the creation, copying, deletion, moving, and opening of files, and aids in the creation of objects.

1







Jolt.GeneratedCode




Provides static methods for the creation, copying, deletion, moving, and opening of files, and aids in the creation of objects.

1



Provides static methods for the creation, copying, deletion, moving, and opening of files, and aids in the creation of objects.

1




Note that the resulting documentation may contain text that is specific to the real subject type, and not very applicable to the proxy or interface types.  This is a minor inconvenience and I believe that many developers will simply ignore it, if not even notice it all.  The big win in implementing this feature is getting parameter information for proxy and interface functions, and Intellisense in general within an IDE.

0 comments: