Julekalender 2004 om Whidbey


5. dec 2004 14:58

De fleste udviklere vil nok hævde, at den kode de producerer er så lysende klar og selvforklarende, at der ikke er det store behov for dokumentation. Opgaven med at lave og vedligeholde dokumentation er måske heller ikke den mest sindsoprivende. Men så alligevel...tjo, tja...der er måske lige et par steder, hvor koden ikke er helt så selvforklarende, som man troede. Og måske var det alligevel meget godt at få lavet noget dokumentation. Når alt kommer til alt. Og så er det jo godt at der findes xml documentation comments. For udfra xml documentation comments indsat i koden er det muligt at generere API-dokumentation og dermed spare en masse arbejde.

Hidtil har xml documentation comments været forbeholdt C# udviklere, men i Whidbey er der i VB også blevet mulighed for at lave xml documentation comments til klasser, metoder, properties og andre members.

I VB laver man xml documentation comments ved at plascere cursoren i linien over f.eks. en metode og indtaste tre enkelt plinger (''') ...og vupti, så kommer der en lille blok over metoden. For C# udviklere er det næsten det samme, der er de tre plinger bare tre forward slashes (///) istedet. Det er forresten værd at bemærke, at parameter-navnene i dokumentationen og i metodesignaturen sammenlignes på kompileringstidspunktet, så man kan sikre konsistens i dokumentationen.

Dette kunne se således ud:

  ''' <summary>
  ''' 
  ''' </summary>
  ''' <param name="sender"></param>
  ''' <param name="e"></param>
  ''' <remarks></remarks>
  Private Sub btnGo_Click(ByVal sender   As System.Object, ByVal e As System.EventArgs) Handles btnGo.Click
    ' Do Something
  End Sub 

Ét er muligheden for at generere dokumentation, noget andet er IntelliSense i Visual Studio. Når man i editor vinduet i Visual Studio er ved at indtaste f.eks. et navn på en metode, så vil IntelliSense vise eventuelle xml documentation comments som et lille tooltip i editor vinduet. Er der ingen xml documentation comments for metoden, så viser IntelliSense blot metodesignaturen.

Og som en ekstra bonus for arbejdet med at kommentere sin kode, kan man så bagefter bruge et værktøj som f.eks. NDoc til at generere msdn-lignende hjælpefiler ud fra xml-filerne.



Abonnér på mit RSS feed.   Læs også de øvrige indlæg i denne Blog.