Estandares de codigo para Jade y Stylus

gistfile1.md

Jade

• minúsculas.
• inglés.
• guión bajo para clases de más de 1 palabra.
• solo los IDs, serán camelCase y no minúsculas.
• los estandares para los nombres de los IDs: http://goo.gl/YrBLlP
• las variables serán en minúsculas, su composición es igual a la de las clases.
• los mixins serán en camelCase.
• no abreviar las palabras excepto(fb, tw, gplus), no importa si la clase se hace muy larga.

Ejemplos:

ID

#frmLogin

Class

.box_center

Variables

page_title

Mixins

getTable

Stylus

• minúsculas.
• inglés.
• guión bajo para clases de más de 1 palabra.
• solo los IDs, serán camelCase y no minúsculas.
• los estandares para los nombres de los IDs: http://goo.gl/YrBLlP
• las variables empezaran con el prefijo: $
• las variables serán en camelCase.
• los mixins serán en camelCase.
• no abreviar las palabras excepto(fb, tw, gplus), no importa si la clase se hace muy larga.

Ejemplos:

ID

#frmLogin

Class

.box_campaign_detail

Variables

$imageWidth

Mixins

htmlClass

CoffeeScript

• inglés.
• las variables y funciones serán en minusculas, si tienen más de una palabra serán en camelCase.
• no abreviar las palabras, no importa si la variable o función se hace muy larga.
• los nombres de los módulos de yOSON serán en minusculas y si tienen más de una palabra tendrán como separador un guión bajo.
• Obligatorio completar los comentarios de la parte superior de los módulos de yOSON.

Ejemplos:

Variables

settings =
    changePasswordLink  : '#changePasswordLink'
    boxNewPassword      : '#boxNewPassword'

Funciones

saveCookie : (cookieKey, cookieValue) ->
    collection = $.parseJSON(Cookie.read(st.cookie))
    collection[cookieKey] = []
    collection[cookieKey] = cookieValue
    Cookie.create(settings.cookie, JSON.stringify(collection))
    return

Nombrar un modulo de yOSON

yOSON.AppCore.addModule "change_password", (Sb) ->

Comentario Principal de un modulo yOSON

###*
Muestra los inputs para cambiar contraseña
@modulejs change_password
@controller default/mi-cuenta
@module default
@author Ana Reyna
###

Enlaces de Interés

• Ejemplo de módulo yOSON aquí