Estándares de escritura C#

Como desarrolladores parte de nuestro tiempo es la escritura del código para las funcionalidades de una solución del negocio. Esta actividad no es solo escribirlo y ya, sino también es escribirlo bien e implementando buenas prácticas.
예를 들어, C# 언어로 코드를 작성하려면 Estandares de la escritura de los hablaremos.

¿Qué es un estandar de escritura?

Primero hay que saber que un estándar es la forma de hacer algo con una serie de rúbricas que lo harán comprensible a otras personas del rubro. Por eso en el código cada una de las lineas debería implementar las buenas practicas.

Algunas de las ventajas de implementarlo son:

Dan una apariencia más coherente a nuestro código, para que los lectores puedan centrarse en el contenido, no en el diseño.

Permiten la rapida comprensión del código al poder hacer suposiciones basadas en experiencias anteriores.

Facilitan la realización de copyas, cambios y mantenimiento del código.

Muestran los procedimientos recomendados.

Recuerda no es solo escribir el código, sino escribirlo bien o como dijo Linus Torvalds

Hablar es fácil. Enséñame el código.

파스칼 케이스

Este tipo de nomenclatura lo utilizaremos al momento de escribir los nombres de nuestras Class , Struct o Record .

// Ejemplo de clases
public class DataService
{
}
// Ejemplo de record
public record PhysicalAddress(
    string Street,
    string City,
    string StateOrProvince,
    string ZipCode);
// Ejemplo de struct
public struct ValueCoordinate
{
}

Uso de Prefijos

일반적으로 사전에 사용하지 않는 경우가 있을 때마다 구현을 할 때까지 결과가 발생합니다. Por ejemplo, para escribir el nombre de unainterfaz utilizaremos el prefijo en mayusaculaI así quien haga una implementación de nuestro código sabrá que eso es unainterfaz .

public interface IWorkerQueue
{
}

También cuando hacemos uso de tipos internal 또는 private colocaremos como prefijo _ .

public class DataService
{
    private IWorkerQueue _workerQueue;
}

O cuando implementamos campos static que sean del tipo private o internal usaremos s_ y para los subprocesos estaticos t_ .

public class DataService
{
    private static IWorkerQueue s_workerQueue;

    [ThreadStatic]
    private static TimeSpan t_timeSpan;
}

카멜 케이스

Cuando escribimos los parametros de method utilizamos la nomenclatura del tipo camelCase .

public T SomeMethod<T>(int someNumber, bool isValid)
{
}

추가 사항

Los estandares adicionales nos ayudarán a encontrar maneras de hacer nuestro código más eficiente y limpio.

예.
Utilizar las interpolaciones proportcionadas por el lenguaje puede resultar en codigo más práctico y fácil de leer.

string displayName = $"{nameList[n].LastName}, {nameList[n].FirstName}";

Cuando necesitamos anexar cadenas en un bucle es una mejor opción implementar un objeto del tipoStringBuilder

var frase= "lalalalalalalalalalalalalalalalalalalalalalalalalalalalalala";
var muchasFrases = new StringBuilder();
for (var i = 0; i < 10000; i++)
{
    muchasFrases.Append(frase);
}
Console.WriteLine("tra" + muchasFrases);

Buenas Prácticas en Uso de 변수

Una buena práctica es utilizar los tipos implícitos solo cuando la asignación hace evidencee el tipo de la variable y en los buclesfor .

var var1 = "This is clearly a string.";
var var2 = 27;

// Bucles for
var frase= "lalalalalalalalalalalalalalalalalalalalalalalalalalalalalala";
var muchasFrases = new StringBuilder();
for (var i = 0; i < 10000; i++)
{
    muchasFrases.Append(frase);
}
//Console.WriteLine("tra" + muchasFrases);

No utilizar tipos implícitos cuando no es evidencee el tipo de la variable o cuando desea determinar el tipo en el bucle foreach .
참고: 변수 유형이 작동하지 않는 경우 실행new 또는 원래 변환이 아닌 것으로 간주합니다.

int var3 = Convert.ToInt32(Console.ReadLine()); 
int var4 = new ExampleClass.ResultSoFar();

No confíe en especificar el tipo de la variable en el nombre.

var inputInt = Console.ReadLine();
Console.WriteLine(inputInt);
// Como se puede obserar el nombre de la variable es engañoso
// ya que inputInt es una _cadena_

En las próximas entregas continuaremos hablando de buenas prácticas de desarrollo con C#, por el momento estas son todas. Hasta la proxima.

¡해피 해킹!