in
Innovasys Logo

Reuse comments from a new project in an older project?

Last post 05-14-2008 10:28 AM by KChew. 2 replies.
Page 1 of 1 (3 items)
Sort Posts: Previous Next
  • 05-06-2008 9:15 AM

    • KChew
    • Top 10 Contributor
    • Joined on 12-05-2007
    • Posts 14

    Reuse comments from a new project in an older project?

    I have a VB.NET project that is version 8.0 in its line. It contains XML comments. Its predecessor, version 7.0, contains most of the same members, but with one crucial difference: it does not contain any XML comments. However, my manager would like a help file for version 7.0.

    I have also created two content files for the 8.0 project. These content files contain examples that should not be in the source code.

    I would like to know: is there a way that I can apply the comments and content from version 8.0 retroactively to version 7.0? I'm looking for any solution easier than cutting and pasting! Whether in Document! X or externally doesn't much matter to me.

    Thanks
    Kevin

  • 05-12-2008 5:02 AM In reply to

    Re: Reuse comments from a new project in an older project?

    The Content File (.dxc) file format is XML, with the qualified name of the item/member that each bit of content applies to defined on each element. It is therefore pretty easy to do a find and replace to repurpose your Content File for a changed assembly / namespace name.

    If you would like to send over your old and new assemblies along with your .dxc file to support@innovasys.com, we can advise specifically on how you can make the Find and Replace in Notepad.

    Richard Sloggett
    Innovasys
    http://www.innovasys.com
  • 05-14-2008 10:28 AM In reply to

    • KChew
    • Top 10 Contributor
    • Joined on 12-05-2007
    • Posts 14

    Re: Reuse comments from a new project in an older project?

    I ended up figuring out that I could use exactly the same content files. I suppose this is because none of the assembly / namespace names have changed?

     While the original project (the "new" project") was based on .vbproj files, I based the current project (the "older" project) on .dlls. This enabled the Typelib HelpString / .NET XML Documentation files options under Content > Comment Extraction, allowing me to select "Use the existing Help text only if no Document! X Content File text is available". Thus the comments from the original project were all used in preference over any non-edited comments in the current project.

     Again, I suspect this only worked because none of the names had changed ... and luckily, using the .dlls was an option.

     

Page 1 of 1 (3 items)