Con quale frequenza vengono utilizzati i commenti nei documenti XML?

3

Al momento sto sviluppando un programma di gestione XML basato sul web per un cliente (anche se potrei "commercializzarlo" per i futuri clienti). Attualmente legge un documento XML, lo converte in oggetti Javascript gestibili e alla fine sputa codice XML indentato e di facile lettura. Modifica: il programma verrebbe utilizzato da client che non hanno voglia di imparare XML per aggiungere elementi o tag, ma io (o un altro sviluppatore XML) posso usare i dati grezzi per modifiche rapide senza usare un editor .

Mi sento fondamentalmente pronto per il rilascio, ma mi chiedo se dovrei andare oltre e consentire il supporto per ricordare (e forse fare) commenti prima di generare l'XML risultante.

Considerando che probabilmente questi file XML non verranno mai letti senza che un programma lo interpreti, dovrei davvero preoccuparmi di aggiungere il supporto per i commenti? Probabilmente sarò l'unico a guardare i file raw, e di solito non uso comunque commenti per XML.

Quindi, i commenti sono comuni / importanti nella maggior parte dei documenti XML?

    
posta Jeffrey Sweeney 19.03.2012 - 17:30
fonte

2 risposte

4

Considering that these XML files will probably never be read without a program interpreting it

Allora quale valore c'è in un programma il cui unico scopo è quello di produrre un "codice XML indentato e facile da leggere"?

So di aver visto molti commenti nei file di configurazione XML (framework Java e simili). Praticamente nessuno nei file di dati.

La vera domanda è chi ti aspetti di usare il programma e per quale scopo. Non possiamo rispondere per questo.

    
risposta data 19.03.2012 - 17:39
fonte
3

I commenti servono a rendere il codice più leggibile. Dovrebbero essere usati come tali.

Se il tuo XML viene letto da umani (cioè file di configurazione), i commenti sono buoni. Se non lo sono, sono semplicemente gonfiati e dovrebbero essere esclusi.

    
risposta data 07.04.2012 - 17:35
fonte

Leggi altre domande sui tag