Innehållsförteckning:

Hur lägger jag till kommentarer till XML i Visual Studio?
Hur lägger jag till kommentarer till XML i Visual Studio?

Video: Hur lägger jag till kommentarer till XML i Visual Studio?

Video: Hur lägger jag till kommentarer till XML i Visual Studio?
Video: Gray or Blue - Which Side Wins? - Colorful and Bright Acrylic Painting! - Acrylic Pouring 2024, April
Anonim

För att infoga XML-kommentarer för ett kodelement

  1. Skriv /// i C#, eller ''' i Visual Basic .
  2. Från menyn Redigera väljer du IntelliSense > Infoga kommentar .
  3. Från högerklicket eller snabbmenyn på eller precis ovanför kodelementet, välj Snippet > Infoga kommentar .

Dessutom, hur skriver jag kommentarer i XML?

Om du vill kommentar ut en enda rad i XML kod, infoga markören i början av en rad du vill kommentar ut. Skriv en mindre än-symbol följt av ett utropstecken och två streck. Flytta markören till slutet av raden och skriv sedan två streck följt av en större än-symbol.

Man kan också fråga sig, hur kommenterar jag kod i C#? Till koda a kommentar , skriv ett dubbelt snedstreck följt av kommentar . Du kan använda den här tekniken för att lägga till en kommentar på sin egen rad eller för att lägga till en kommentar efter koda på en linje. Ofta när du koda , du kanske vill kommentar ut ett helt block av koda uttalanden.

För det andra, vad är XML-kommentarer i C#?

En av dessa är XML Dokumentation kommentarer , ibland kallad XML-kommentarer , som börjar med ett trippelt snedstreck - ///. XML-kommentarer kan användas av IntelliSense-funktionen i Visual Studio och VS Code för att visa information om en typ eller medlem; denna information kommer från det du lägger i din koddokumentation.

Hur dokumenterar du kod?

Bästa metoder för att skriva dokumentation:

  1. Inkludera en README-fil som innehåller.
  2. Tillåt problemspårare för andra.
  3. Skriv en API-dokumentation.
  4. Dokumentera din kod.
  5. Tillämpa kodningskonventioner, såsom filorganisation, kommentarer, namnkonventioner, programmeringsmetoder, etc.
  6. Inkludera information för bidragsgivare.

Rekommenderad: