Home  |  News  |  About  |  Features  |  Documentation  |  Download  |  Buy  |



Main documentation page
FAQ
Install instructions
Getting started
Using templates
Configuration parameters
Commandline builds
Tips
Known issues
Release history

The VBXC FAQ

The VBXC items in my tools menu are gone
This is probably caused by a crash or that the VS.NET IDE has lost some of the persisted information about the menu items. You can try to fix this by doing the following:

  • Close all instances of VS.NET

  • Doubleclick on the RebuildMenus.reg file in the folder where you installed VBXC

  • Open one instance of VS.NET and verify that the menu is back

  • Close the instance so the menu can be persisted to the registry


  • If the above did not help, you could try the following:
  • Close all instances of VS.NET

  • Start | Run : devenv / setup

  • Open one instance of VS.NET and verify that the menu is back

  • Close the instance so the menu can be persisted to the registry
  • What happened to VBXMLDoc?
    In December 2002 an user sample was posted on www.gotdotnet.com, with the name VBXMLDoc. As a result, I've changed the name of VBXMLDoc, as it was not the same add-in.

    What does it cost?
    The beta1 and beta2 are free until the 1.0 release is made available. After that time, all commercial use of the add-in require you to purchase a valid license. Pricing and instructions on how to get a valid licence will be published shortly. Currently, I plan to make VBXC 1.0 free for personal use, but the final decision will be announced parallel to the licence pricing information.

    Why isn't it freeware anymore?
    When the development on the add-in started in June 2002 it appeared as a small and trivial task. However, between beta1 and beta3, so much work has been put into VBXC that I do not feel that it is justifiable that companies can make money by using the add-in without paying for it. Therefore, I've decided to make the add-in payware. This way I'm able to put even more time into making the add-in the best XML commenting solution for VB.NET.

    Why not wait until Microsoft adds support for XML comments to VB?
    Microsoft has announced that XML comments will be available for VB.NET in the widbey release. As it is a while until widbey is available, 'native' XML comments in VB.NET won't be available for quite some time. One important aspect of documentation is that if it is not added while developing it'll rarely get written later either, if it's not a product that require user documentation. In other words: You should use VBXC to document your code until VB.NEt provides support for XML commenting natively, then you could choose between the two. VBXC will most likely be providing conversion routines fot users that wish to switch between implementations.

    Where can I download it?
    Download it at the download page

    What tags does VBXC support?
    VBXC has no strict checking of what tags you use in your documentation, so you can use any tags you want. If you have comment validation switched to on, the comment has to be valid XML in order to get placed in the resulting XML file. The add-in has special handling of include tags and in 1.0, special handling of cref attributes will be available.

    Why doesnt the available beta support the cref attribute?
    Supporting the cref attribute like in C# is far from a trivial task, one have to implement the same method and type lookup algorithm as VB.NET uses. So far the main focus have been to get the essential parts of VBXC working and making it stable, but handling cref attributes is indeed on the task list. Until VBXC get's the same support for cref attributes as C# has you can enter the full name of the type/method/property and prefix it with the correct letter. The cref implementation in VBXC will also handle crefs that already has a prefix.

    Does VBXC support building XML comments from the commandline?
    Currently VBXC used the VS.NET extensibility model to parse most of the VB.NET code to generate the XML comment file, that means you have to use VS.NET to generate your XML comment file. But it can be done from the commandline in two different ways. See the documentation for more info. There are plans for a standalone commandline util that can generate the XML comment file, but it's not planned in the 1.0 release.

    Does VBXC work with the build comment webpage feature?
    No it does not. Instead, you could use your own XSLT stylesheet or use NDoc to generate a documentation webpage for you.

    Is there any known issues in the latest release?
    Look at the known issues page for a list of known issues in the latest release.

    I've a found a bug / got a feature request what should i do?
    Send a mail to vbxc@tor-erik.net with the bug and/or feature request.




    Tor-Erik Hagen © 2002-2003