Indholdsfortegnelse:

Hvordan tilføjer jeg kommentarer til XML i Visual Studio?
Hvordan tilføjer jeg kommentarer til XML i Visual Studio?

Video: Hvordan tilføjer jeg kommentarer til XML i Visual Studio?

Video: Hvordan tilføjer jeg kommentarer til XML i Visual Studio?
Video: 8.3 Document Comments - Learning C# 2024, November
Anonim

At indsætte XML-kommentarer for et kodeelement

  1. Indtast /// i C#, eller ''' i Visual Basic .
  2. Fra menuen Rediger skal du vælge IntelliSense > Indsæt kommentar .
  3. Fra højreklik eller kontekstmenu på eller lige over kodeelementet skal du vælge Snippet > Indsæt kommentar .

Desuden, hvordan skriver jeg kommentarer i XML?

Hvis du vil kommentar ud en enkelt linje i XML kode, indsæt din markør i begyndelsen af en linje, du vil kommentar ud. Indtast et mindre-end-symbol efterfulgt af et udråbstegn og to bindestreger. Flyt markøren til slutningen af linjen, og skriv derefter to tankestreger efterfulgt af et større-end-symbol.

Man kan også spørge, hvordan kommenterer jeg kode i C#? Til kode -en kommentar , skriv en dobbelt skråstreg efterfulgt af kommentar . Du kan bruge denne teknik til at tilføje en kommentar på sin egen linje eller for at tilføje en kommentar efter kode på en linje. Ofte når du kode , vil du måske kommentar ud en hel blok af kode udsagn.

For det andet, hvad er XML-kommentarer i C#?

En af disse er XML Dokumentation kommentarer , nogle gange kaldet XML kommentarer , som starter med en tredobbelt skråstreg - ///. XML kommentarer kan bruges af IntelliSense-funktionen i Visual Studio og VS Code til at vise information om en type eller et medlem; disse oplysninger kommer fra det, du har lagt i din kodedokumentation.

Hvordan dokumenterer du kode?

Bedste fremgangsmåder til at skrive dokumentation:

  1. Inkluder en README-fil, der indeholder.
  2. Tillad problemsporing for andre.
  3. Skriv en API-dokumentation.
  4. Dokumenter din kode.
  5. Anvend kodningskonventioner, såsom filorganisering, kommentarer, navnekonventioner, programmeringspraksis osv.
  6. Inkluder oplysninger til bidragydere.

Anbefalede: