Lägga dokumentation till ditt Visual Basic NET ( VB.NET ) Projektet är viktigt så att personer som använder ditt program har en plats att hitta mer information om funktioner de har problem med . . Visual Studio använder '' ' för att beteckna en dokumentation linje , som automatiskt skapar en XML- mall för . När du kompilerar ditt projekt , kommer Visual Studio skapa en XML -fil från alla dina dokumentation kommentarer . Saker du behöver
Microsoft Visual Studio 2005 , 2008 eller 2010
Visa fler instruktioner
1
Öppna din VB.NET projekt i Microsoft Visual Studio 2005 , 2008 eller 2010 .
2
Leta koden för en typ eller medlem som du vill dokumentera och placera markören på raden ovanför koden . En typ innehåller saker såsom ett gränssnitt eller klass . Bland medlemmarna finns saker som en subrutin , funktion , händelse eller egendom .
3
Lägg '' ' ( 3 enkla citat tecken ) till början av raden . Detta anger en dokumentation linje . Koden Editor kommer att lägga en XML skelettet motsvarande element på raden under.
4
Lägg din dokumentation som text mellan XML-taggar . Det är möjligt att lägga till nya XML-taggar Dokumentation Kommentera genom att redigera " VBXMLDOC.xml " filen med en textredigerare . Filen ligger i Visual Studio för " Application Data " eller " AppData " mappen . Lägg några extra rader kod med XML dokumentation synpunkter som använder den typ eller medlem
5
. En tagg kommer att visa ytterligare information om vilken typ eller medlem .
6 Klicka projektet på Solution Explorer . Klicka på " Project " -menyn och klicka på " Egenskaper . " Klicka på " Compile " fliken och lägg till " /doc " i " Generera XML dokumentation " rutan . Detta talar om för kompilatorn att skapa en XML-fil när du kompilerar projektet .
7
Skapa en XML- dokumentation genom att sammanställa din VB.NET projektet . Filen kommer att visas i samma mapp som din . Exe eller . Dll-fil .
