Las funciones deberían comenzar con "Obtener"?

Question

Estoy tratando de ver los Estándares de codificación C# para hacer que mi código sea más bonito y estándar, y tengo una pregunta: ¿Las funciones (métodos que no son vacíos), de acuerdo con los estándares de codificación C#, deberían comenzar con "Obtener "¿?" Por ejemplo: "GetSongOrder()", "GetNextLine()" etc.?

Gracias.

Answer 1

Hay dos casos:

Si la rutina puede "obtener" el valor muy rápidamente, sin causar efectos secundarios en el código, le recomiendo usar una propiedad de captador, y omitiendo el nombre de "obtener":

public SongOrder SongOrder 
{ 
    get { return this.songOrder; } // ie: an enum 
} 

Si, no obstante, se requiere procesamiento, entonces es apropiado un método con el nombre "Obtener ...". Esto sugiere que puede haber efectos secundarios a llamar a este método, como el procesamiento adicional, o un cambio en un cierto estado:

public string GetNextLine() 
{ 
    string line = this.stream.ReadLine(); // This may cause a longer running operation, especially if it's using Disk IO/etc 
    // do other work? 
    return line; 
} 

Answer 2

no he visto un estándar de C# en eso, pero la mayor parte del código real he visto usos escritos propiedades "getter" y omitir la palabra "Obtener" desde el nombre de la función. Ejemplo:

Public SongOrderList SongOrder 
{ 
    get 
    { 
     return mySongOrderList; 
    } 
} 

El uso de "Get" (y "Set") como un nombre de función de prefijo es algo que suelo ver en langauges que no tienen propiedades a la NET (lenguajes como C, Java) .

Editar:

... y por supuesto se puede tener demasiado set

Public SongOrderList SongOrder 
{ 
    get 
    { 
     //do some processing code here 
     return mySongOrderList; 
    } 
    set 
    { 
     //do some processing code here 
     mySongOrderList = value; //value is a C# keyword, in case you didn't know. it is the parameter to the setter 
    } 
} 

Por supuesto, si quieres un getter y setter y que no necesitan ningún procesamiento adicional , simplemente Pure Java-bean-como/set youc un hacer esto:

Public SongOrderList SongOrder 
    { 
     get; set; 
    } 

Si sólo desea un captador públicos puede hacer esto (creo - que ha sido un tiempo):

Public SongOrderList SongOrder 
    { 
     public get; private set; 
    } 

Answer 3

El nombre de su función debe ser sucinto y tener sentido. Nada más y nada menos.

Si funciona para usted, entonces use Get. Si Recuperar funciona, úsalo.

No existe un verdadero "estándar" para las convenciones de nomenclatura.

Answer 4

En general, es común una convención de nombres Verb-Sustantivo para funciones. 'Obtener' es solo uno de los verbos que puede ver. También podría ser 'Activar', 'Cerrar', 'Volcar', o cualquier cosa ... es solo una consecuencia de la codificación general y en inglés que un método o función típicamente 'Hacer algo' a 'Algún tipo de objeto (s) '.

Answer 5

No, no existe una norma que la función debe comenzar con "Get".

Al crear nombres de funciones que tengan sentido, a menudo toman esa forma, como la función GetHashCode. Otros verbos al principio son comunes, como en la función ToString, y solo verbos como en la función Encode.

Existen otras formas, en las que se describe el resultado de la función, como la función Substring.

Answer 6

Además de otras respuestas, si tiene un método como GetNextLine(), le recomendamos que devuelva una enumeración, p.

IEnumerable<Line> GetLines();