What are the challenges you face when working across database platforms? Take the survey
Options

Extract inline comments (a la Javadoc?)

viveksinhaviveksinha Posts: 2
edited April 21, 2011 2:18PM in SQL Doc Previous Versions
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

Comments

  • Options
    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.
  • Options
    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).
Sign In or Register to comment.