Estandar basico de programación
Todos los archivos fuentes deberán comenzar con un encabezado que muestre el nombre de la clase, la versión y la fecha.
/*
* Nombre de la Clase
* Versión
* Fecha
*/
Lalongitud de las líneas del encabezado no deberá ser mayo a 80 caracteres. Cuando una línea tenga una longitud mayor se dividirá tomando en cuenta los siguientes criterios:
• Se dividirá después deuna coma.
• Se dividirá después de un operador.
• Alineé el inicio de la nueva línea con el inicio de la expresión anterior ó utilice un espacio de tabulador al inicio de la nueva línea encaso de que sea inconveniente la primera opción.
Ejemplos de separado de líneas
function(longExpression1, longExpression2, longExpression3,
longExpression4, longExpression5);
longName1= longName2 * (longName3 + longName4 - longName5)
+ 4 * longname6;
private static synchronized horkingLongMethodName(int anArg,
Object anotherArg, String yetAnotherArg,Object andStillAnother) {
...
}
Comentarios
Para los blques de comentarios utilice:
/* Línea 1
* Línea 2
* Línea 3
*/
Para los comentarios de una sola línea utilice:
/*Comentario*/
ó
// Comentario
Para los comentarios de fin de línea utilice:
System.Int32 intValue; // Integer value
Para los comentarios de documentación
[…]
Declaraciones
Se debe hacer unadeclaración por línea ya que esto fomenta la utilización de comentarios.
int value;
string name; // Recomendado
int value; string name; // No recomendado
La inicialización de las variables debeser preferentemente al momento de su declaración.
int value = 0;
string name = String.Empty;
bool flag = false;
La declaración de las variables debe ser al principio del bloque en el que se vana utilizar.
void miMetodo()
{
int int1 = 0; // Al inicio del bloque del método miMetodo().
…
if (condition)
{
int int2 = 0; // Al inicio del bloque if....
Regístrate para leer el documento completo.