doc/docstrip: è lo stato dell’arte?

  • Creatore
    Topic
  • #46489
    Stemby
    Partecipante
      Up
      0
      Down
      ::


      Salve,
      mi sto documentando su come si fa a scrivere una classe “come da manuale”. La documentazione che sto consultando non è aggiornatissima, quindi, prima di perdere ore e ore inutilmente, sapete rispondere alla domanda del topic? Ad esempio su The LaTeX Companion si accenna a xdoc2 o xdoc.

      Altra curiosità: sempre su The LaTeX Companion ho visto che viene illustrata l’integrazione con i sistemi di controllo versione, ma si citano solo RCS e CVS… esiste la possibilità di interfacciarsi con sistemi un po’ più moderni? (Git in particolare)

      Grazie!

    Visualizzazione 1 filone di risposte
    • Autore
      Risposte
      • #46490
        OldClaudio
        Partecipante
          Up
          0
          Down
          ::


          Secondo me, che uso sempre doc/docstrip, non c’è molta differenza fra un metodo di literate programming ed un altro; si tratta sempre di commentare abbondantemente il file sorgente della classe, secondo al sintassi propria del sistema in uso in modo che il codice sia chiaro sia a chi l’ha scritto sia a chi lo legge, in modo che a distanza di mesi o di anni si possa capire quello che si è fatto.
          Annotare i file sorgente dei programmi è una cosa che o non si fa mai (o non lo si fa a sufficienza) o lo fanno solo i programmatori professionisti.

          Un file di classe è un programma; se usi solo comandi di alto livello, i nomi die comandi sono più o meno autoesplicativi, ma specialmente i comandi interni per i programmatori (quelli che contengono lettere maiuscole, per intenderci) i commenti possono essere ridotti al minimo; se si usano molto i comandi primitivi del linguaggio TeX (vedi the TeXbook) è bene che ogni cosa sia documentata a dovere, perché spesso quei comandi fanno cose che i comandi LaTeX di solito non fanno.

          Quindi il problema non è tanto se sia meglio doc/docstrip oppure xdoc2 o xdoc, ma è quello di scrivere un buon programma adeguatamente commentato. Il controllo della versione è una cosa importante, ma, secondo me secondaria rispetto alla qualità del programma.

          Siccome mi pare di capire che stai per scrivere la tua prima classe, concentrati su quella; poi le altre cose verranno da sole.

        • #46491
          Stemby
          Partecipante
            Up
            0
            Down
            ::


            Ok, grazie mille!

        Visualizzazione 1 filone di risposte
        • Devi essere connesso per rispondere a questo topic.

        Go to top