Obteniu els fets amb aquesta guia pas a pas
Si està interessat a afegir comentaris de referència al seu codi XML, utilitzeu aquest tutorial pas a pas per obtenir orientació. Podeu aprendre a executar aquesta funció en només cinc minuts. Tot i que el procés és fàcil de completar, encara haureu de conèixer alguns aspectes bàsics sobre els comentaris XML i la seva utilitat abans de començar.
Per què els informes XML són útils
Els comentaris en XML són gairebé idèntics als comentaris en HTML, ja que tots dos tenen la mateixa sintaxi. L'ús de comentaris us permet entendre el codi que heu escrit fa anys. També pot ajudar a un altre desenvolupador que revisi el codi que vau desenvolupar entendre el que vau escriure. En resum, aquests comentaris proporcionen context per al codi.
Amb els comentaris, podeu deixar fàcilment una nota o eliminar parcialment un codi XML. Tot i que l'XML està dissenyat per ser "dades que descriuen l'autodeterminació", de vegades, és possible que hàgiu de deixar un comentari XML.
Començant
Les etiquetes de comentaris estan formades per dues parts: la part que comença el comentari i la part que la remata. Per començar, afegiu la primera part de l'etiqueta de comentari el comentari que vulgueu. Només assegureu-vos que no anireu comentaris en altres comentaris (vegeu suggeriments per obtenir més informació).
Després d'això, tancareu l'etiqueta de comentari ->
Consells útils
Quan afegiu comentaris de referència al vostre codi XML, recordeu que no es poden trobar a la part superior del document. En XML, només pot aparèixer la declaració XML:
Com es va esmentar anteriorment, els comentaris no poden ser niats en un altre. Heu de tancar el primer comentari abans d'obrir un segon. A més, els comentaris no es poden produir dins de les etiquetes, p. Ex.
Mai utilitzeu els dos guions (-) en qualsevol lloc, però al principi i al final dels vostres comentaris. Qualsevol cosa en els comentaris és efectivament invisible per l'analitzador XML, així que tingueu molt en compte que el que queda és encara vàlid i ben format.
Embolcall
Si encara teniu preguntes sobre com afegir comentaris de referència al codi XML, és possible que vulgueu llegir un llibre per fer-vos una idea detallada de com funciona el procés. Els llibres com ara la referència de programador C # 5.0 de Rod Stephens poden ser útils. Consulteu els minoristes en línia o la vostra biblioteca local per a llibres similars.