0

Tagged SQL Comments - not appearing in DocumentX

PRobinson

25 June 2008 04:10

None

Follow

I've included comment headers similar to the following into the top of new stored procedures:

/*======================================================================
-- ##SUMMARY Put_a_brief_summary_of_the_object_here_single_line_only
-- ##REMARKS Enter_any_notes_about_the_object_can_be_multi_line
-- ##RETURNS Document_the_return_type_of_the_procedure
========================================================================= */

I was expecting the the details to appear in the relevant sections next time my DocumentX project was opended. While the SP appears with as expected, the description, remarks and returns text boxes are blank. The server is SQL 2005.

Is there anything I have missed to get the tagged comments to appear in the DocumentX documentation.

• Facebook
• Twitter
• LinkedIn

2 comments

• 0
  
  Matt Bates 01 July 2008 04:39

  I apologize for any inconvenience this problem has caused you.

   Unfortunately at this time SQL source comments are not displayed in the content file. The SQL source comments will be visible in your output along with any additional content authored in the content file editor.

   
  I have logged adding visiblity of SQL source comments in the content file as a feature request for a future update.
   

• 0
  
  Permanently deleted user 14 October 2012 21:09

  For the benefit of anyone coming across this post, in the current version Sql source comments are displayed whilst you are working in the Content File editor - so you can see exactly what content already exists before authoring additional content in the Content File editor.