Would be nice to have support for docblocks like you do in PHP #3

Activity

1. whitlockjc commented on Mar 16, 2014

   

   whitlockjc

   on Mar 16, 2014

   Member

   More actions

   The issue is there is no language specific documentation format for JavaScript and to make the problem worse, there are conflicting options out there. Off the top of my head, there's JSDoc and YUIDoc but thankfully both are similar enough so to add some generic support. What do you think of this:

   • Scoping tags (Example: @param)
   • Scoping tag arguments, where possible (Example: Scoping the type and name of the param tag)

   Any feedback you can provide will help me make a decision on how to do this.
2. ryanfitzer commented on Feb 11, 2016

   

   ryanfitzer

   on Feb 11, 2016

   More actions

   I created a grammar in my personal bundle to give very simple support for docblocks:

   {   patterns = (
           {   name = 'comment.block.documentation.jsdoc';
               begin = '(/\*\*)\s*$';
               end = '\*/';
               beginCaptures = { 1 = { name = 'punctuation.definition.comment.begin.jsdoc'; }; };
               endCaptures = { 0 = { name = 'punctuation.definition.comment.end.jsdoc'; }; };
               patterns = (
                   {   include = '#inline'; },
                   {   name = 'meta.documentation.tag.jsdoc';
                       begin = '(\@)(\S+)';
                       end = '(?=^\s*\*?\s*@|\*/)';
                       beginCaptures = {
                           1 = { name = 'punctuation.definition.keyword.jsdoc'; };
                           2 = { name = 'keyword.other.documentation.$2.jsdoc'; };
                       };
                       patterns = ( { include = '#inline'; } );
                   },
                   {   match = '((\@)\S+)\s';
                       captures = {
                           1 = { name = 'keyword.other.documentation.custom.jsdoc'; };
                           2 = { name = 'punctuation.definition.keyword.jsdoc'; };
                       };
                   },
               );
           },
       );
       repository = {
           inline = { patterns = ( { include = '#inline-formatting'; } ); };
           inline-formatting = { patterns = ( ); };
       };
   }
   

   Here's the preview:

   

   If you think it would be useful in this bundle, I'd be interested in making it more robust.

   👍React with 👍1Reacted by Adrien Becchis
3. infininight commented on Jul 30, 2016

   

   infininight

   on Jul 30, 2016

   Member

   More actions

   Basic support has been added, currently matches the blocks and tags used by JSDoc.
4. infininight

   closed this as completedon Jul 30, 2016
5. ryanfitzer commented on Aug 4, 2016

   

   ryanfitzer

   on Aug 4, 2016

   More actions

   Thanks for adding in some support!