Capítulo 45. Convenções de codificação do PostgreSQL

Sumário
45.1. Formatação
45.2. Mensagens de erro geradas pelo servidor
45.3. Guia de estilo para mensagens de erro
45.3.1. O que vai aonde
45.3.2. Formatação
45.3.3. Aspas
45.3.4. Uso das aspas
45.3.5. Gramática e pontuação
45.3.6. Maiúsculas versus Minúsculas
45.3.7. Evitar a voz passiva
45.3.8. Presente versus Passado
45.3.9. Tipo do objeto
45.3.10. Colchetes
45.3.11. Montagem das mensagens de erro
45.3.12. Motivos dos erros
45.3.13. Nomes das funções
45.3.14. Palavras ambíguas a serem evitadas
45.3.15. Escrita apropriada
45.3.16. Localização

45.1. Formatação

A formatação do código fonte utiliza um espaçamento de tabulação de 4 colunas, com as tabulações preservadas (ou seja, as tabulações não são expandidas em espaços). Cada nível lógico de recuo (indentation) é uma parada adicional de tabulação. As regras de posicionamento (colocação das chaves, etc.) seguem as convenções BSD.

Embora as correções submetidas não sejam obrigadas a seguir, de forma alguma, estas regras de formatação, é uma boa idéia segui-las. O código será processado por pgindent e, portanto, não existe motivo para fazê-lo parecer elegante segundo um conjunto de convenções de formatação diferente.

Para o Emacs devem ser adicionadas as seguintes linhas (ou algo semelhante) no arquivo de inicialização ~/.emacs:

;; verificar arquivos com caminho contendo "postgres" ou "pgsql"
(setq auto-mode-alist
  (cons '("\\(postgres\\|pgsql\\).*\\.[ch]\\'" . pgsql-c-mode)
        auto-mode-alist))
(setq auto-mode-alist
  (cons '("\\(postgres\\|pgsql\\).*\\.cc\\'" . pgsql-c-mode)
        auto-mode-alist))

(defun pgsql-c-mode ()
  ;; configurar a formatação para o código C do PostgreSQL
  (interactive)
  (c-mode)
  (setq-default tab-width 4)
  (c-set-style "bsd")             ; definir c-basic-offset como 4, e outras coisas
  (c-set-offset 'case-label '+)   ; tweak case indent to match PG custom
  (setq indent-tabs-mode t))      ; manter as tabulações nos recuos

Para o editor vi o arquivo ~/.vimrc, ou equivalente, deve conter o seguinte:

set tabstop=4

ou, de maneira equivalente, dentro do vi deve ser utilizado:

:set ts=4

As ferramentas de exibição de texto more e less devem ser chamadas utilizando

more -x4
less -x4

para mostrarem a tabulação de forma apropriada.

SourceForge.net Logo