xml comment observation

Posts   
 
    
like2175
User
Posts: 83
Joined: 27-Mar-2006
# Posted on: 06-Apr-2009 15:48:47   

When editing vb source if I type ''' (3 x single quotes) the editor automatically inserts a template xml comment above a function/sub like this:

''' <summary>
  ''' 
  ''' </summary>
  ''' <param name="sender"></param>
  ''' <param name="e"></param>
  ''' <remarks></remarks>

however whenever I'm in a piece of llblgen generated code the ''' doesn't trigger the editor to produce the xml comment.

VS2008 VB Oracle 9.2 LLBLgen 2.6

Walaa avatar
Walaa
Support Team
Posts: 14946
Joined: 21-Aug-2005
# Posted on: 06-Apr-2009 16:18:57   

Reproduced.

Looking into it.

Otis avatar
Otis
LLBLGen Pro Team
Posts: 39588
Joined: 17-Aug-2003
# Posted on: 06-Apr-2009 16:32:44   

I've no idea why this happens, it's not something we have control over, as it's a VB.NET editor shortcut. it might be that the ''' trigger only triggers if the file contains spaces instead of tabs. Our generated code contains tabs instead of spaces for indenting, it might be that this is the cause. it also might be a setting on the vb.net project properties in vs.net, not sure.

Also, it might be a bug in the vb.net editor and perhaps it's fixed in vs.net 2008 sp1.

Frans Bouma | Lead developer LLBLGen Pro
like2175
User
Posts: 83
Joined: 27-Mar-2006
# Posted on: 06-Apr-2009 16:47:14   

Workaround:

Right Clicking on the Sub/Function then picking - Insert Comment seems to do the trick!

(Although the xml comments I enter don't then appear in the intellisense.)

BTW SP1 doesn't fix it!

Otis avatar
Otis
LLBLGen Pro Team
Posts: 39588
Joined: 17-Aug-2003
# Posted on: 06-Apr-2009 18:40:57   

Strange... simple_smile

Well, I'd advice you to install Ghostdoc. Then you press cntr-D and it inserts the commends and also text based on the method name and parameters so you have a good start on the xml comments simple_smile

Frans Bouma | Lead developer LLBLGen Pro