Come denominare il parametro filename per renderlo chiaro dovrebbe contenere il percorso completo? [chiuso]

Question

Come denominare il parametro filename per renderlo chiaro dovrebbe contenere il percorso completo? [chiuso]

#1 da (4 voti)

4

Sto cercando la denominazione vitale del parametro stringa filename nell'elenco dei parametri utilizzato in vari metodi in cui è previsto nomefile con percorso completo . In molti casi, anche il percorso UNC può essere fornito come percorso completo perché molte librerie gestiscono in modo nativo.

Solitamente chiamo il parametro solo filename , ma può essere fuorviante in due modi:

I principianti tendono a pensare che sia solo il nome del file - senza percorso.
Se è necessario suddividere il valore in percorso e nome file, il termine nomefile si attacca meglio con la parte nome file senza percorso visualizzata dopo la divisione. Ad ogni modo, non è facile dare alla seconda parte un nome migliore di filename . L'alternativa di dividere filename in path e filenameOnly mi sembra strana.

Penso che potrebbe essere meglio usare termini chiaramente distinguibili per nome file con percorso che prendere in prestito nome file che ha già un significato più strong per qualcos'altro.

Stavo pensando al termine absoluteFilePath o fullyQualifiedFilename come a nomi di argomenti. Forse sono bravi e ho bisogno solo di incoraggiamento per iniziare a usarli, ma mi piacerebbe capire le tue migliori pratiche.

EDIT: mi piacerebbe continuare ad usare VB.NET ufficiale denominazione e maiuscole convenzioni, quindi l'unica cosa di cui ho bisogno è aiutare l'affilatura è chiara dicitura auto-documentante del termine. (Non se dovrei usare la notazione ungherese o no - non posso.)

naming conventions file-handling

posta miroxlav 20.04.2014 - 15:11

fonte

1 risposta

Leggi altre domande sui tag naming conventions file-handling

Quando utilizzare un metodo statico invece di un costruttore? L'argomento dell'ereditarietà di zope.interface (fornito da vs isinstance)

score 4 · Accepted Answer

Sembra che sarebbe più sicuro definire un contratto di codice.

Si può dire che una precondizione di questo metodo è che il percorso fornito è un percorso assoluto .

Puoi renderlo più chiaro nominando il parametro di input String absolutePathToFile .

E infine, puoi far fallire presto il tuo metodo se non sono soddisfatte le condizioni preliminari. Fai questo controllando se absolutePathToFile è effettivamente un percorso assoluto. In caso contrario, lancia un'eccezione di argomento.

Quindi, anziché prendere semplicemente il nome di un parametro e sperare che i prossimi sviluppatori a) prestino attenzione ad esso, eb) comprenderlo nello stesso modo in cui lo fai (entrambi i quali sono improbabili), fai quanto segue:

Contratto di codice : dichiara esplicitamente le precondizioni del tuo metodo. Puoi metterlo nella tua documentazione, o come documentazione del metodo inline (se la tua lingua / ide lo supporta)
Codice auto-documentale : scegli un nome parametro che descriva ciò che vuoi nel modo più chiaro possibile (non sempre facile)
Programmazione difensiva : controlla i parametri del tuo metodo per vedere se sono validi. In caso contrario, fallisci e fallisci presto.