How can we help you today? How can we help you today?

Extract inline comments (a la Javadoc?)

Hello,

Can SQL Doc extract inline documentation/comments? We have a number of stored procedures from which we'd like to be able to extract such information. We've annotated it like Java doc (/** **/). We are looking for something that can extract this information, in addition to the MS_Description field.

Thanks,

Vivek
viveksinha
0

Comments

2 comments

  • Linda Hawksworth
    This feature has been requested by a number of other customers. It is logged in our tracking system with reference SDOC-775. I have added your comments and ticket reference to the issue and it will be considered for a future release of SQL Doc.
    Linda Hawksworth
    0
  • gregmac
    Any update on this? I was just searching for info about how it documents stored procedures. I have several created in SQL management studio, which have a default header with:
    -- =============================================
    -- Author:		Greg
    -- Create date: 2011-03-21
    -- Description:	Does something, which is useful when doing 
    --              something else.. blah blah blah..
    -- =============================================
    ALTER PROCEDURE [dbo].[doSomething]
    

    It doesn't extract any of that info right now, all the documentation for each stored procedure is basically blank (shows the list of parameters, but no descriptions anywhere).
    gregmac
    0

Add comment

Please sign in to leave a comment.