Guia de Estilo - eTecnologia/projeto-genesis GitHub Wiki
Guia de Estilo (Style Guide)
Quando estamos desenvolvendo um software, temos que escrever programas, classes, métodos e funções entre outras coisas. Na maioria das vezes, esquecemos que outras pessoas podem ler e querer entender o nosso código, caimos na armadilha de escrever algo que não legível e entendivel para demais pessoas. Neste momento percebemos que estamos precisando criar uma forma de escrever melhor nossos códigos para que outras pessoas sejam capazes de ler e entender o código.
Essa forma de escrita é conhecida como Guia de Estilo de Programação.
O que é um Guia de Estilo?
Guia de Estilo de Programação é um conjunto de convenções, regras e princípios sobre como escrever código para um produto de software.
Objetivo do Guia é criar um estilo consistente para simplificar a escrita de código e facilitar entendimento do produto de software.
Por que precisamos de um Guia de Estilo?
Para estabelecer a padronização de escrita de código, aumentar a legibilidade do código, simplificar o entendimento da código.
Isso é importante, pois facilita a evolução do produto de software, ajuda na manutebilidade e ainda simplifica a refatoraçao de código.
Para se inspirar
Existem diversos Guias de Estilo no mercado, abaixo uma lista de Guias para se inspirar:
Guia de Estilo do Google
Guia de Estilo do Google no GitHub
Guia de Estilo da Apple
Guia de Estilo da RedHat
Guia de Estilo da Microsoft
Python: Guias de Estilo
Style Guide for Python Code
Google Python Style Guide
The Hitchhiker's Guide to Python
.Net
.NET Standard
.NET Secure Coding Guidelines
.NET Naming Guidelines
PHP
PHP FIG - PHP Standards Recommendations
PHP The Right Way
Java
Code Conventions for the Java
Google Java Style Guide
Guia de Estilo da Linguagem Go
JavaScript Standard Style
Ruby Style Guide
Airbnb’s JavaScript Style Guide
Angular’s Style Guide
C
C Padrão de Código (Coding Standard)
C Programming/Structure and style
C#
C# Coding Conventions
The Official raywenderlich.com C# Style Guide
C# Coding Standards Best Practices
C++
Google C++ Style Guide
C++ Core Guidelines
SQL
SQL Style Guide
DART
DART Style Guide