Pregunta

Dónde leer (la mejor práctica en) el formato del código fuente, para idiomas individuales, es decir, cuáles son las convenciones para nombrar variables, etc., para la sangría y dónde colocar llaves, cómo y dónde incluir comentarios, etc.

Por ejemplo, para el libro de C Kernighan y Ritchie The C Programming Language y guía de estilo de codificación del kernel de Linux o Guía de estilo de C ++ de Google y para Perl al menos perlstyle - guía de estilo Perl .

Editar: Quizás debería haber preguntado " Cómo obtener un buen comienzo con los estilos de codificación " ;.

¿Fue útil?

Solución

No daría demasiado en tales guías de estilo. Son un buen comienzo, pero al final, usted o su equipo desarrollarán sus propios estilos de codificación.

EDIT: Rob Kam hizo un comentario, que quiere saber más sobre estas 'convenciones de inicio'.

Ese es un buen punto. Pero principalmente se unirá a proyectos existentes, proyectos de código abierto o comerciales, y las personas que trabajan en ellos ya tienen un código de convención. En una empresa probablemente ya exista una convención de código. Si inicia un nuevo proyecto, comience con las convenciones de otro proyecto que hizo anteriormente.

Si realmente comienza un nuevo proyecto con un nuevo idioma que no usó antes ... entonces podría comenzar con convenciones de otro idioma que sea similar (es decir, para un nuevo lenguaje oo puede usar convenciones de Java). o Smalltalk) y ajuste sus convenciones a medida que adquiera experiencia para el nuevo idioma. Cuando comencé a programar en Java usé mis convenciones de codificación de Pascal. Algunas de las convenciones de pascal no funcionaron muy bien para Java, pero con el tiempo dejé caer algunas convenciones antiguas y desarrollé nuevas.

S.Lott tuvo la idea de estudiar un proyecto de código abierto escrito en el idioma de su elección. Esa es una buena idea para obtener algunas sugerencias sobre buenas convenciones. Srikanth tuvo la buena idea de pedir buenas convenciones aquí en Stackoverflow. Una muy buena idea, porque con el tiempo Stackoverflow se convertirá en una buena referencia para las convenciones de codificación de esta manera.

Otros consejos

Lo que es mejor que un libro es localizar el código de fuente abierta en su idioma preferido.

En lugar de un libro, el trabajo de algunos autores y editores, el código fuente en funcionamiento es un proyecto comunitario que cumple con los estándares comunitarios altamente evolucionados.

Cuando el cliente me pide ayuda con los estándares de codificación, prefiero encontrar un buen proyecto de código abierto y proporcionar un documento corto de estándares que diga "haga que se vea como xxx". Un buen ejemplo que uso para el estilo Java es el proyecto Apache Ant .

Todos tienen su proyecto favorito de ejemplo de código abierto. Lee un código de trabajo del mundo real y elige un favorito. Emula ese proyecto.

Yo usaría Google para ello. Por ejemplo, para buscar las Pautas de codificación de Java, usaré esta consulta o publíquela en Stack Overflow y pregunte cuáles son las pautas estándar de codificación recomendadas para Java. Es difícil señalar una sola fuente para todos los idiomas.

Le sugeriría que elija uno para su empresa / proyecto, que se mantenga y se asegure de que sea un buen estándar.

Realmente recomendaría leer el Clean Code de tío Bob si está preocupado por cuestiones de estilo de código.

Hay tres buenos lugares para mirar.

  1. Libros populares sobre el idioma que estás usando.
  2. Proyectos de código abierto escritos en su idioma.
  3. Compruebe las utilidades de tipo de estilo para su idioma.

Si usa una herramienta como Checkstyle o PMD, tenga en cuenta que muchas de las " reglas " Su cumplimiento puede ser controvertido. Podría ser útil consultar la documentación para averiguar de qué reglas hay que tener cuidado.

Microsoft tiene una documento de referencia con sus convenciones de codificación que pueden ser útiles a la vista, incluso si no está utilizando C #. Más allá del estilo y las convenciones básicas, los libros de mejores prácticas recomendados por otros aquí, como Clean Code , son lecturas esenciales para crear un código legible y mantenible que tenga sentido para los futuros mantenedores de su base de código.

Si está utilizando Visual Studio (y algunos otros IDE modernos), las incoherencias básicas con las convenciones recomendadas se subrayan automáticamente (con sugerencias sobre el desplazamiento en las versiones recientes de VS). En VS, si su equipo quiere usar estándares diferentes, simplemente abra las propiedades del proyecto y cambie la configuración para " Análisis de código " (último elemento del menú de la izquierda). Más aquí: Uso de conjuntos de reglas para agrupar reglas de análisis de código

Hola y buen día para todos

Bueno, debo decir que depende Depende de si trabajas para una empresa. o si trabajas para ti;)

Si trabaja para una empresa, debe aceptar el estilo de nomenclatura y otras reglas

y para ti, solo necesitas establecer un estilo que todos, incluyéndote a ti mismo, puedan entender instantáneamente qué y cómo

los corchetes y otros es tu camino

pero como dijiste, hay idiomas individuales, por lo que tienen reglas propias

y al igual que Mnementh dijo que todos los equipos tienen una manera de codificar de forma restringida o gratuita

Eso es todo sin mas .... adios adios

Hay las guías de estilo C y C ++ , una página corta de enlaces a guías de estilo, reglas de codificación y discusiones de USENET, mantenidas por Christopher Lott.

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top