[R-es] Una guía de estilo para programar en R... ¿comentarios?

[Jorge Luis Ojeda Cabrera]

En mi opinión, y de cara a compartir el código, las guías de estilo son 
FUNDAMENTALES. Ahora bien, creo que deben ser lo más breves posibles: 
minimalistas. La idea es que no sea necesario tener en cuenta muchas 
reglas. Respecto de los nombres de objetos, creo que salvo reglas muy 
generales, y que tengan en cuenta particularidades de la sintaxis, es
mejor que cada proyecto defina y determine su propia nomenclatura.


Le he echado un vistazo a la guía y me parece Ok, quizás un poco extensa 
en los que a combinación de indentado y contrucción de bloques,
pero es muy complicado y pesado ser exhaustivo.


Bajo mi punto de vista, y además de nombre de ficheros, variables, 
etc..., incluye los aspectos más importantes, que creo son:
  - Indentado: fundamental para leer código, me gusta lo del doble esp.
  - Construcción de bloques: generalmente los abro y se cierro en lineas
    nuevas, pero es cierto que resulta mejor como se indica en la guía.
    OBS: Creo que se debería considerar el que los bloques de
    definición de funciones se abran y cierren en lineas nuevas.
  - Formato de comentarios, de TODOs, documentación propia para la
    definición de las funciones.
    OBS: Quizás puede resultar interesante incluir como cabecera del
    fichero unos comentarios(en un formato determinado) indicando Autor,
    Copyright, descripción con la finalidad del código,...

Saludos, Jorge.



El 02/11/10 23:29, Carlos J. Gil Bellosta escribió:
> Hola, ¿qué tal?
>
> Hace poco vi que Google había hecho pública su guía de estilo interna
> para programar en R:
>
> http://google-styleguide.googlecode.com/svn/trunk/google-r-style.html
>
> Me tomé la libertad de traducirla:
>
> http://datanalytics.com/guia_estilo_r.html
>
> Cuanto más pienso en ella, más carencias veo. Escribí sobre ello en mi
> blog (
> http://www.datanalytics.com/blog/2010/11/01/una-propuesta-de-guia-de-estilo-de-r/
> ). Las dos pegas principales que le veo son:
>
> 1) Que no hace mención a los paquetes (y cómo pueden utilizarse para
> gestionar la documentación de las funciones, etc.).
>
> 2) Que parece una traslación directa de una guía de estilo de Python o
> Java, ignorando (algunas) particularidades específicas de R.
>
> Creo que disponer de una buena guía de estilo es importante a la hora de
> elaborar código en equipo. Por eso quiero plantear las siguientes dos
> preguntas en la lista:
>
> 1) ¿Echáis algo de menos en la guía de Google? ¿Omite algo relevante?
> ¿Qué experiencia tenéis al respecto? ¿Cuál es la mejor política a la
> hora de diseñar paquetes?
>
> 2) ¿Habría alguien interesado en colaborar para recoger estas nuevas
> propuestas y mantener una propuesta de guía de estilo de R que pueda
> servir a grupos de programadores?
>
> Un saludo,
>
> Carlos J. Gil Bellosta
> http://www.datanalytics.com
>
> _______________________________________________
> R-help-es mailing list
> R-help-es en r-project.org
> https://stat.ethz.ch/mailman/listinfo/r-help-es
>