GERENCIA Fecha: 11/18/2020

IT Página: 1 de 13
Revisión: 1.0

LINEAMIENTOS INTERNO NOMENCLATURA

EN DESARROLLO SOFTWARE

Fecha
Nombre / Rol Firma
(dd/mmm/yyyy)

Autor Eden Gonzalez 11/11/2020

Reviso

Aprobó*

*
Las firmas anteriores indican que los aprobadores están de acuerdo con el contenido del
documento y aseguran que será aplicable dentro de su dominio de experiencia.
 GERENCIA Fecha: 11/18/2020
IT Página: 2 de 13
Revisión: 1.0

Lista de distribución

Nombre & Departamento Justificación

Historial de versiones

Fecha
Versión Modificación
(dd/mmm/yyyy)
 GERENCIA Fecha: 11/18/2020
IT Página: 3 de 13
Revisión: 1.0

Contenido
Glosario................................................................................................................................................
1 Introducción..................................................................................................................................
1.1 Propósito....................................................................................................................................
1.1 Alcance del documento.............................................................................................................
1.2 Responsabilidades....................................................................................................................
2 Lineamiento...................................................................................................................................
2.1 Desarrollo...................................................................................................................................
2.2 Nomenclatura de clase, Estructuras e Interfaces...................................................................
2.3 Nomenclatura métodos y propiedades....................................................................................

List of Revisors
Glosário
1 Introduction
1,1 Intention 4
1,2 Target of document 4
1,3 Responsibility 4
1,4 List of Petitions 4
2 Specification Technique
2,1 Aim of Operation 5
2,2 Standard 5
2,3 XSDs referenciados 5
3 Functional Detailing
3,1 Description of process 8
3,2 Main flow 8
3,3 Mapping of Data 11
3,4 Treatment of Errors 11
3.4.1 Invalid parameters 11
3.4.2 Combination De Campos not allowed 12
3.4.3 I make a mistake Unexpected, in the execution of the service of
business 12
3.4.4 I make a mistake Unexpected invoking enablement
ValidateOperation 13
 GERENCIA Fecha: 11/18/2020
IT Página: 4 de 13
Revisión: 1.0

3.4.5 I make a mistake treaty returned for the Enablement

ValidateOperation 14
3.4.6 I make a mistake Unexpected invoking the translator of errors 14
4 Description of Revisions
 GERENCIA Fecha: 11/18/2020
IT Página: 5 de 13
Revisión: 1.0

Glosario

Termino Definición

1 Introducción
 GERENCIA Fecha: 11/18/2020
IT Página: 6 de 13
Revisión: 1.0

1.1 Propósito

Este documento describe los lineamientos para el desarrollo de

software .NET el cual tiene como propósito:

 Crear una apariencia coherente en el código, para que los lectores puedan
centrarse en el contenido, no en el diseño.
 Permitir a los lectores comprender el código más rápidamente al hacer
suposiciones basadas en la experiencia anterior.
 Facilitar la copia, el cambio y el mantenimiento del código.

1.1 Alcance del documento

Este documento explica el uso de nomenclatura para el desarrollo de

software en la plataforma Microsoft.

1.2 Responsabilidades

Es responsabilidad del equipo KBAE el mantenimiento y actualización del

documento:

 SCRUM MASTER: Validar que los lineamientos sean aplicados, así como
certificar la calidad de los entregables.
 DEV TEAM: Equipo o Individuo encargado de aplicar los lineamientos.
 COORDINADOR: Creación y actualización de lineamiento.
 GERENCIA Fecha: 11/18/2020
IT Página: 7 de 13
Revisión: 1.0

2 Lineamiento

2.1 Desarrollo

Objeto / Ejemplo
Estilo Formato
Elemento
KBAEAcademy
Solution Nombre del proyecto
LTSS
LTSS.Library.TMS
Project Solition.Type.Module
LTSS.Library.Tools
LTSS.Desktop.HumanResources
LTSS.Desktop.IT
LTSS.Web.Logistic
PascalCas LTSS.WebApi.Planing
e HumanResources
Class
EmployeeDepartmentHistory
Name
Properties
LastName
public static void
Method
PrintAttributes(Type
attribType, int iAttribValue)
public static void
Parameter
PrintAttributes(Type
attribType, int iAttribValue)
Object Customer objCustomer = new
camelCase
Customer();
Variables float matrix[10][15];
var result;
var resultsHistory;
Constant UPPERCASE Las constantes deben public const int MONTHS = 12;
declararse al inicio del public const int WEEKS = 52;
código. public const int DAYS = 365;

Los identificadores no deben de tener mezcladas palabras en español e

inglés, por ejemplo:

 GetInformacion
 SetColeccionPersonas

Se recomienda que los identificadores estén en inglés, en caso de que en su

proyecto los identificadores manejen nombres en español, deben de existir una
consistencia en los nombres.

Si nuestro proyecto decidimos utilizar los identificadores en inglés,

deberemos tener identificadores como:

 GetInfoCollection
 GERENCIA Fecha: 11/18/2020
IT Página: 8 de 13
Revisión: 1.0

 SetInfo
 GetAllSettings

Y si nuestro proyecto decidimos utilizar los identificadores en español,

deberemos tener identificadores como:

 ObtenerColeccionInfo
 AsignarInfo
 ObtenerTodaConfiguracion

No deben utilizarse abreviaturas o contracciones para los identificadores, por

ejemplo:

OnBtnClk, debe usarse OnButtonClick

Los acrónimos solo deben ser utilizados cuando son conocidos y utilizados
por el grupo de desarrollo o pertenecen al proyecto que se está desarrollando, y
solo deben de usarse en un identificador cuando es estrictamente necesario

2.2 Nomenclatura de clase, Estructuras e Interfaces

El nombre de los tipos debe de ser sustantivos, donde el sustantivo es la

entidad representada por el tipo, por ejemplo:

 Persona
 Material
 Oficios

Cada nombre representa la entidad asociada con ellos, estos nombres deben de
identificarse desde la perspectiva del desarrollador y reflejar el uso que se da.

1. No deben utilizarse prefijos para el nombre de las clases, de ningún tipo, ya

que para la organización y jerarquía de las clases existen los namespaces.

2. El nombre de interfaces debe de iniciar con la letra I mayúscula, sin

excepciones.
 GERENCIA Fecha: 11/18/2020
IT Página: 9 de 13
Revisión: 1.0

3. Se recomienda que cuando se hereda de una clase, el nombre de la clase

termine con el nombre de la clase que hereda, por ejemplo:

Persona hereda AnalistaPersona o TrabajadorPersona.

Nota: Tome de ejemplo en el .NET Framework todos los objetos que se

derivan de la clase Stream, terminan en Stream(MemoryStream, FileStream,
etc).

4. Cuando una clase sea la implementación estándar o interna de una interface,

el nombre de la clase solo debe de ser diferente quitando la letra I del nombre
de la inteface, por ejemplo, si tenemos la interface IPersona, la clase
estándar que la implementa debe llamarse Persona.

5. Cuando se usen tipos genéricos como parámetros, deben de utilizarse

nombres descriptivos, sin excepción, en caso de que el tipo de parámetro
este asociado a una clase o interface agregue el prefijo T para indicar que es
un tipo genérico de template.

Por ejemplo, si se tiene la siguiente sentencia:

IDictionary <TLlave,TValor>

Se apega al lineamiento, ya que los nombres son descriptivos y tienen el

prefijo T. En caso de las enumeraciones, no utilice ningún prefijo, ya que le
nombre de la enumeración en unión con su namespace debe ser lo
suficientemente descriptiva. No debe de usarse los sufijos, enum, flag, etc. El
nombre de la enumeración debe ser en plural, para indicar que contiene
varios valores o estados.

2.3 Nomenclatura métodos y propiedades

Los nombres de los métodos deben de corresponder a verbos o frases verbales.

El nombre del método debe de tener el verbo que describe el método y dar a
entender a los desarrolladores la funcionalidad del método. El nombre no debe
describir como lo hace, si no lo que el método hace, no deben usarse detalles de la
implementación o del algoritmo en el nombre del método.
 GERENCIA Fecha: 11/18/2020
IT Página: 10 de 13
Revisión: 1.0

 El nombre de las propiedades debe usar sustantivos o adjetivos. Algunas

frases o adjetivos se consideran correctas ya que las propiedades contienen
datos.
 El nombre de la propiedad no debe ser igual al nombre de los métodos para
obtener datos, por ejemplo, si tiene la propiedad RegistroEmpleado y el
método ObtenerRegistroEmpleado en la misma clase, el desarrollador que
vea la clase no sabrá que método usar para obtener la información del
registro.
 Los métodos deben de estar documentado:

/// <summary>
/// The following code example demonstrates the use of the DoWork event
/// to start an asynchronous operation. This code example is part of a
/// larger example provided for the BackgroundWorker class.
/// </summary>
/// <param name="activityID">Used to indicate activityID.</param>
/// <param name="name">Used to indicate user name.</param>
public static void DoWork(int activityID, string name)
{
}

 Las propiedades de tipo booleano pueden completarse con una frase

afirmativa (Tiene, puede, es, etc) por ejemplo TieneDescendientes o
EsAdministrador.