Se sei interessato ad aggiungere commenti di riferimento al tuo Codice XML, usa questo tutorial passo passo come guida. Puoi imparare come eseguire questa funzione in soli cinque minuti. Sebbene il processo sia facile da completare, dovresti comunque conoscere alcune nozioni di base sui commenti XML e sulla loro utilità prima di iniziare.
Perché i commenti XML sono utili?
I commenti in XML sono quasi identici ai commenti in HTML, poiché entrambi hanno la stessa sintassi. Utilizzo dei commenti ti permette di capire il codice che hai scritto anni prima. Può anche aiutare un altro sviluppatore che sta rivedendo il codice che hai sviluppato a capire cosa hai scritto. In breve, questi commenti forniscono un contesto per il codice.
Con i commenti, puoi facilmente lasciare una nota o rimuovere temporaneamente parte di un codice XML. Anche se XML è progettato per essere "dati autodescrittivi", a volte potrebbe essere necessario lasciare un commento XML.
Iniziare
I tag di commento sono composti da due parti: la parte che inizia il commento e la parte che lo termina. Per iniziare, aggiungi la prima parte del tag commento:
Quindi scrivi il commento che desideri. Assicurati solo di non nidificare commenti all'interno di altri commenti (vedi suggerimenti per maggiori dettagli). Successivamente, chiuderai il tag del commento:
-->
Consigli utili
Quando aggiungi commenti di riferimento al tuo codice XML, ricorda che non possono trovarsi nella parte superiore del documento. In XML, solo la dichiarazione XML può venire prima:
Come accennato in precedenza, i commenti non possono essere annidati uno dentro l'altro. Devi chiudere il tuo primo commento prima di aprirne un secondo. Inoltre, i commenti non possono verificarsi all'interno dei tag, ad es.
.
Non usare mai i due trattini (--) ovunque tranne che all'inizio e alla fine dei tuoi commenti. Qualsiasi cosa nei commenti è effettivamente invisibile al Analizzatore XML, quindi state molto attenti che ciò che rimane sia ancora valido e ben formato.
Avvolgendo
Se hai ancora domande sull'aggiunta di commenti di riferimento al codice XML, potresti voler leggere un libro per darti un'immagine dettagliata di come funziona il processo. Libri come"Riferimento per programmatori C# 5.0" di Rod Stephens può rivelarsi utile.