Document! X 2017
Visual Studio Integration / Visual Studio Integration Fundamentals
In This Topic
    Visual Studio Integration Fundamentals
    In This Topic

    Create a new Document! X project

    1. Open your Visual Studio solution.
    2. Click on the Document! X  toolbar button.
      Your solution will need to be built before a Document! X project can be created in Visual Studio, Document! X will display a warning if no compiled assemblies for the open solution can be found when creating a new project.
    3. Select the assemblies compiled from this solution to add to the new Document! X project.
    4. Click OK.

     

    Edit XML source comments

    1. Open your Visual Studio solution.
    2. Open the code file that you want to edit XML source comments for. The Visual Studio integrated comment editor supports the following types of code files: .vb, .cs, .cpp, .h
    3. Click on the Edit Documentation  toolbar button.
      The Visual Studio integrated comment editor can also be opened for a specific code file from the context menu in the Solution Explorer.
    4. Select the code element to edit XML source comments for (assemblies and namespaces do not support XML source comments).
      If there is a Document! X project available in your solution then a Build Profile picker combobox will be available in the top right hand corner of the Visual Studio integrated comment editor which will allow you to select which Build Profile to use at design and preview time.
    5. Enter XML source comment content in the Summary field.
    6. Switch back to the code file window, the following XML comment will have been added to the selected code element: <summary>XML source comment content</summary>

     

    Build a Document! X project

    A Document! X project will need to exist as part of the open Solution in order to build it.

    Right-click on the Document! X project in the Solution Explorer and select the Build context menu option

    - or -

    Hold shift and click on the Document! X  toolbar button.