2 583
edições
Convenções gerais SQL (ver código-fonte)
Edição das 17h48min de 7 de maio de 2023
, 7 de maio de 2023sem sumário de edição
Sem resumo de edição |
mSem resumo de edição |
||
| Linha 1: | Linha 1: | ||
Convenções de sintaxe e | Convenções de sintaxe, estilo e documentação para ''scripts'' [[wikipedia:SQL|SQL]], '''para os projetos em geral do Instituto AddressForAll'''. Principais tipos de convenção adotadas: | ||
* '''Estilo''' sintático: dentre as várias alternativas que a linguagem SQL oferece para se escrever a mesma coisa, quais recomendamos. | * '''Estilo''' sintático: dentre as várias alternativas que a linguagem SQL oferece para se escrever a mesma coisa, quais recomendamos. | ||
* '''Documentação''': onde e como documentar. A principal recomendação aqui é "use o comando COMMENT" do SQL. Além disso existe um parser que gera código mediawiki para postar nesta Wiki. | * '''Documentação''': onde e como documentar. A principal recomendação aqui é "use o comando COMMENT" do SQL. Além disso existe um ''parser'' que gera código mediawiki para postar nesta Wiki. | ||
** Documentação e estilo: devido ao parser algumas partes da documentação podem ser expressas em <code>-- informal comm</code> | ** Documentação e estilo: devido ao parser algumas partes da documentação podem ser expressas em <code>-- informal comm</code> | ||
* '''Testes''': requisitos mínimos de teste, tipicamente usando comando ASSERT em scripts dedicados, ou gerando a partir . | * '''Testes''': requisitos mínimos de teste, tipicamente usando comando ASSERT em scripts dedicados, ou gerando a partir . | ||