SubMain - CodeIt.Right The First Time!

/Community

A Support Community for SubMain Products
 Home Products Services Download Purchase Support
in Search
 
Home Forums Blogs Tutorials Downloads
Welcome to SubMain Community Sign in | Join | Help

Idea to document Javascript

Last post 12-02-2009, 10:45 AM by Serge B.. 4 replies.
Sort Posts: Previous Next
  •  11-18-2009, 7:27 AM 972

    Idea to document Javascript

    The code layout for javascript within visual studio is very similar to C#. It would nice to be able to right click on a javascrpt function an say document this or atleast it just create a basic comment block.

     

    Just an idea I had yesterday.

    Filed under:
  •  11-19-2009, 5:05 PM 973 in reply to 972

    Re: Idea to document Javascript

    Thank you for the suggestion. We will think about it.

    One question though - how would XML Comments be of use for JavaScript?

     


    Thank you,
    Serge Baranovsky
    http://submain.com - .NET Developer Tools  |  Microsoft VB MVP  |  http://vbcity.com - VB Developer Community
    » » (Static Code Analysis + Automatic Refactoring) / Painless Coding Guidelines = CodeIt.Right - http://submain.com/codeit.right
    » » C#/VB .NET Coding Guidelines - FREE 100+ page ebook (PDF) http://submain.com/guidelines
  •  12-02-2009, 3:21 AM 997 in reply to 973

    Re: Idea to document Javascript

    Serge B.:

    One question though - how would XML Comments be of use for JavaScript?

     It's used in intellisense - http://weblogs.asp.net/scottgu/archive/2007/06/21/vs-2008-javascript-intellisense.aspx

    Filed under:
  •  12-02-2009, 3:21 AM 998 in reply to 973

    Re: Idea to document Javascript

    Serge B.:

    One question though - how would XML Comments be of use for JavaScript?

    It's used in intellisense - http://weblogs.asp.net/scottgu/archive/2007/06/21/vs-2008-javascript-intellisense.aspx

    Filed under:
  •  12-02-2009, 10:45 AM 999 in reply to 998

    Re: Idea to document Javascript

    We will add this to our list although I see two fairly major issues with the implementation and the value of the feature. GhostDoc as is now relies on VS CodeDOM to get the method information, to my knowledge JavaScript code cannot not be reached through the CodeDOM. Also GhostDoc a major factor in generating (or "guessing" rather) of the comment text is following MS .NET style naming conventions, most JavaScript frameworks/code follow very different naming convention (or none at all) which negates the value of the comments to be generated...

    What do you think?


    Thank you,
    Serge Baranovsky
    http://submain.com - .NET Developer Tools  |  Microsoft VB MVP  |  http://vbcity.com - VB Developer Community
    » » (Static Code Analysis + Automatic Refactoring) / Painless Coding Guidelines = CodeIt.Right - http://submain.com/codeit.right
    » » C#/VB .NET Coding Guidelines - FREE 100+ page ebook (PDF) http://submain.com/guidelines
View as RSS news feed in XML
 
     
 
Home |  Products |  Services |  Download |  Purchase |  Support |  Community |  About Us |