in
Innovasys Logo

DocumentX trims spaces in comments

Last post 03-01-2010 9:59 AM by Richard Sloggett (Innovasys). 1 replies.
Page 1 of 1 (2 items)
Sort Posts: Previous Next
  • 02-28-2010 5:45 AM

    DocumentX trims spaces in comments

    Hello,

     

    I'm evaluating Document! X at the moment for documenting SQL Server databases and it has much more features and the output looks much cleaner than Red Gate's SQLDoc.

     

    That said, DocumentX has an annoying feature, which is that it seems to want to delete contigeous white-spaces.

    It is a problem if you use spaces for indentation and not tabs, but even more so in comments.

    We have an header on top of all our UDFs and stored procedure which goes likes this:

    /****************************************************************/
    /* Stored Procedure: spProcName                                                                     */

     

    However, DocumentX strips the contiguous white spaces from the comments, which gives something like:

    /****************************************************************/
    /* Stored Procedure: spProcName */

     

    which doesn't look good at all.


    It is a no-no for us as we do not have these problems with Red Gate SQLDoc.

     

    Also, is it possible to remove the "stored procedure" suffix assigned on the documentation tree.

    For example, under the "Stored procedures", all the stored procedures underneath it are suffixed by "stored procedure" after their name, which seems redundant. Is there an option to control this setting?


    Thanks.

     

  • 03-01-2010 9:59 AM In reply to

    Re: DocumentX trims spaces in comments

    This behavior is one down-side of us supporting Html in comments - html treats continuous white space as a single character. You should be able to get around the problem either by using &nbsp; in place of spaces (pretty ugly) or by surrounding your comment with a <pre> </pre> tag.

    Richard Sloggett
    Innovasys
    http://www.innovasys.com
Page 1 of 1 (2 items)