• Numerare le righe per una buona documentazione del codice sorgente

    documentare-codice-300.jpg

    Open Office Writer è un buon programma per la stesura di documenti e relazioni, sia di natura tecnico-commerciale che legale. In alcune occasioni avremo la necessità o il desiderio di documentare del codice sorgente scritto in un linguaggio di programmazione (ad esempio delle Macro OpenOffice o del codice C o Java ecc).

    In tali casi sarà molto utile (se non indispensabile) fare dei riferimenti precisi e puntuali alle parti di codice di cui si sta discutendo. Per avere un richiamo certo e inconfondibile è utile poter numerare le linee del testo introdotto.

    Per farlo in maniera semplice e del tutto automatica ci potremo servire della funzione “tool->Line Numbering”. Questa funzione di Open Office Writer consente al tool open source di aggiungere il numero di riga sul margine sinistro della pagina per potere identificare ogni linea singolarmente e darne un riferimento univoco e inequivocabile.

    La funzione è utile e consente di numerare una riga ogni n (con n=5 di default; n=1 cioè ogni riga nell’esempio dello screenshot allegato), usare diversi stili di numerazione, usare diversi formati (1 2 3, I II III, A B C ecc), scegliere la posizione precisa del numero sul margine, inserire un separatore periodico di riga, contare o escludere le righe vuote.

    Questa funzione interna è utilissima per un tocco professionale ai propri report tecnici che contengano codice sorgente di ogni tipo (nell’esempio riportato c’è la macro per il calcolo del giorno di Pasqua già discussa in un articolo precedente).

    Ma la funzionalità ha tanti potenziali ulteriori usi, ad esempio come contarighe per documenti a righe limitate (es: contratti di locazione con 25 righe per foglio), utile riferimento per documenti legali, interessante guida per documenti da revisionare. Una funzione semplice che aiuterà il redattore di un documento a dare al destinatario maggiore facilità di lettura e controllo della relazione.

    Tags:

    Se vuoi aggiornamenti su Numerare le righe per una buona documentazione del codice sorgente inserisci la tua e-mail nel box qui sotto:


    Ho letto e acconsento l'informativa sulla privacy

    Si No

    Acconsento al trattamento dei dati personali di cui al punto 3 dell'informativa sulla privacy

    Si No

    Commenta

    Your email address will not be published. Required fields are marked *