Nomi dei parametri delle funzioni [chiuso]

-1

Ho appena trovato il seguente codice nella nostra base di codice:

public String identifyArchitectureName(String platformName, String input) ...

A mio parere input è uno dei nomi più insignificanti di una variabile che può essere. Sono solo io? Posso tranquillamente cambiarlo, ma dovrei rivolgermi al collega programmatore che l'ha fatto?

    
posta Vic 05.04.2012 - 10:46
fonte

6 risposte

5

Dipende dal contesto per me.

string GetEncrypted(string input)

abbastanza ovviamente, input è una stringa da cifrare. A cosa cambieresti questo parametro?

Uso anche str per i metodi che eseguono conversioni o manipolazioni di stringhe

MyEnum Parse(string str) // what could str be? login? password? text to be parsed?

public static int? TryToInt(this string str)

Non penso che sia lo stesso di

public String identifyArchitectureName(String platformName, String input) 
    
risposta data 05.04.2012 - 11:03
fonte
4

Parte del lavoro con gli altri è educare / insegnare / tutorarli, in particolare se hai anzianità.

Prendilo con lo sviluppatore e trova un nome migliore insieme .

    
risposta data 05.04.2012 - 10:56
fonte
1

Hai ragione sul fatto che l'immissione del nome non comunichi molto bene l'intenzione. Uncle Bob parla di "Boy Scout Rule" nel suo libro Clean Code : "Lascia che il campeggio sia più pulito di quanto tu non abbia trovato ". L'idea è che se si effettua il refactoring del codice ogni volta che si tocca, è impossibile degradare la qualità del codice. Quindi sentiti libero di sostituire il nome del parametro in uno più descrittivo.

Non necessariamente confronterei il mio collega per una singola istanza come quella. Se questo tipo di convenzioni di denominazione errate sono tipiche del tuo progetto, allora dovresti riunire la tua squadra e formulare convenzioni comuni su denominazione, stile, ecc. Quindi, dopo che tutti conoscono le regole, possono essere applicate con le revisioni del codice.

Tuttavia, tutti commettono errori e il pignolo su un nome di parametro non è bello :) basta sistemarlo e andare avanti con qualsiasi cosa tu stia facendo

    
risposta data 05.04.2012 - 11:15
fonte
0

Intendi input ? Basta cambiarlo, se pensi che ci sia un nome migliore.
È un parametro, rinominandolo non infrange alcun codice.

    
risposta data 05.04.2012 - 10:52
fonte
0

Ho due menti sul fatto che dovresti affrontare l'altro programmatore.

Il mio primo pensiero è che sarei incline a rinominarlo e farcela.

Mentre dovremmo essere grandi ragazzi a ricevere critiche, avere una conversazione sul nome di un parametro sul valore nominale sembra quasi un po 'meschino o esagerato.

Detto questo, se questo fosse solo uno di una serie di "piccole cose piccole", posso vedere che potrebbe essere la goccia che fa traboccare il vaso.

Hai un processo formale di revisione tra pari che potresti coprire?

    
risposta data 05.04.2012 - 11:03
fonte
0

Cambialo? Certo.

Affronta l'altra persona? Non così in fretta. Preferisco vederti dare il via ad una discussione di gruppo sugli standard di codifica e aggiungere un paragrafo al documento degli standard di codifica (ne hai uno, giusto?) Che specifica che nei casi non banali, i parametri formali dovrebbero essere auto-documentanti.

    
risposta data 05.04.2012 - 12:20
fonte

Leggi altre domande sui tag