Taula de continguts:

Com afegeixo comentaris a XML a Visual Studio?
Com afegeixo comentaris a XML a Visual Studio?

Vídeo: Com afegeixo comentaris a XML a Visual Studio?

Vídeo: Com afegeixo comentaris a XML a Visual Studio?
Vídeo: Как знать, что папка растет слишком много с TREESIZE. Избегайте вирусов 2024, Abril
Anonim

Per inserir comentaris XML per a un element de codi

  1. Escriviu /// en C#, o ''' en Visual Basic .
  2. Al menú Edita, trieu IntelliSense > Insereix comentari .
  3. Des del clic dret o del menú contextual de l'element de codi o just a sobre, trieu Fragment > Insereix comentari .

A més, com puc escriure comentaris en XML?

Si vols comentar una sola línia al XML codi, inseriu el cursor al començament de la línia que vulgueu comentar fora. Escriviu un símbol de menys que seguit d'un signe d'exclamació i dos guions. Mou el cursor al final de la línia i després escriviu dos guions seguits d'un símbol més gran que.

També es pot preguntar, com puc comentar el codi en C#? A codi a comentar , escriviu una doble barra inclinada seguida de comentar . Podeu utilitzar aquesta tècnica per afegir un comentar en la seva pròpia línia o per afegir a comentar després de la codi en una línia. Sovint quan tu codi , potser voldreu comentar fora un bloc sencer de codi declaracions.

En segon lloc, què són els comentaris XML en C#?

Un d'aquests és XML Documentació comentaris , de vegades anomenat Comentaris XML , que comença amb una barra inclinada triple - ///. Comentaris XML pot ser utilitzat per la funció IntelliSense de Visual Studio i VS Code per mostrar informació sobre un tipus o membre; aquesta informació prové del que poseu a la documentació del vostre codi.

Com documenteu el codi?

Bones pràctiques per escriure documentació:

  1. Incloeu un fitxer README que contingui.
  2. Permet el seguiment de problemes per a altres persones.
  3. Escriu una documentació de l'API.
  4. Documenteu el vostre codi.
  5. Aplicar convencions de codificació, com ara organització de fitxers, comentaris, convencions de denominació, pràctiques de programació, etc.
  6. Incloeu informació per als col·laboradors.

Recomanat: