Come posso presentare un codice sorgente Visual Basic stampato in modo esteticamente gradevole?

Naviga le tue risposte
7

In questo momento sono internato in un'importante società di ingegneria. Parto tra qualche mese, quindi il mio project manager ha richiesto una stampa del mio codice sorgente per un progetto VBA su cui ho lavorato.

Vorrebbe averlo rivisto per essere certo di non aver fatto nulla di ridicolo, e di assicurarsi che sia organizzato abbastanza bene da permettere a qualcuno di mantenerlo abbastanza facilmente una volta che me ne sarò andato.

Non sono proprio sicuro del motivo per cui vorrebbe una stampa al posto dei file, ma dal momento che l'editor VBA è brutto come il peccato, questa è probabilmente una buona cosa.

Vorrei fare un'impressione con questo - per quanto minore - quindi la mia domanda è: come posso rendere questo aspetto professionale? Ad esempio, forse ci sono alcuni caratteri che hanno senso qui, forse potrei applicare uno schema di colori alle parole, ecc.?

    
posta Austin R 22.01.2013 - 00:16
fonte

3 risposte

12

Usa qualcosa come Notepad ++ o un'applicazione di evidenziazione della sintassi simile che stamperà il tuo codice a colori (se ti è permesso). Altrimenti, il bianco e nero va bene, ma il colore con l'evidenziazione rende più facile la lettura. Alcuni punti da considerare:

  • Assicurati di avere una spaziatura e una formattazione coerenti nel tuo codice e il tuo codice è leggibile come puoi.

  • Assicurati che qualsiasi codice che si estende su una riga sia stampato correttamente, potresti aver bisogno di fare un po 'di caos.

  • Usa un carattere a spaziatura fissa - migliorerà la leggibilità per miglia. Ancora una volta, la maggior parte delle applicazioni "avanzate" simili a un blocco note lo fanno automaticamente per impostazione predefinita.

  • Stampa con numeri di riga, come in una revisione del codice basata su carta molte persone faranno riferimento a un numero di riga anziché a un'istruzione quando fanno un commento.

  • Inserisci un'intestazione e / o un piè di pagina che contenga il nome del file / modulo e il numero di pagina. Anche con i numeri di linea stampati, è bello avere i numeri di pagina per dare ai tuoi lettori un modo semplice per ordinare le pagine nel caso in cui vengano confuse.

risposta data 22.01.2013 - 01:00
fonte
3

Se lo hai capito correttamente

He would like to have it reviewed to make sure I didn't do anything ridiculous, and to make sure it's organized well enough for someone to maintain easily enough once I'm gone.

allora questo è il tuo obiettivo, non l'estetica o per compiacerlo perché ti fa sentire meglio.

Quando scrivo codice che è destinato ad altri, lo scrivo per altri con buoni commenti, nomi di variabili significative, seguendo le convenzioni di formattazione standard della lingua o del gruppo e proseguo.

Se non hai provato a sabotare la compagnia con codice malevolo, probabilmente passerai il primo requisito. Se hai fiducia nel tuo codice e buoni commenti, allora di più hai bisogno di soddisfare i suoi requisiti. Stampalo, consegnalo e vai avanti.

    
risposta data 22.01.2013 - 01:05
fonte
-5

"... una stampa del mio codice sorgente ..." - Non preoccuparti. Probabilmente non lo leggerà nemmeno. In passato ho avuto manager del genere - una lunga strada nel passato ... nei vecchi dipartimenti governativi ... che non avevano idea di cosa fosse la programmazione - anche allora.

Se vuoi davvero farlo, basta scaricare il tuo codice e dimenticarlo. Sospetto che sia intenzionalmente in disordine con te o che sia totalmente in 404. In entrambi i casi, impressionarlo non ti avvantaggerà in alcun modo e una richiesta del genere sarebbe sufficiente per mettere questa azienda nella mia lista "Never want to work there" .

    
risposta data 22.01.2013 - 00:28
fonte

Leggi altre domande sui tag

Termine per una classe con più interfacce La maggior parte produce output in fase di programmazione ma non apprende nulla [chiuso]