FormatoModulos

De Stoq Wiki
Ir para: navegação, pesquisa

Os comentários de todos os módulos Stoq/Stolib deverão sempre obedecer o seguinte padrão abaixo. Informações extras sobre os módulos de domínio em ClassesDominio.

Headers

# -*- Mode: Python; coding: utf-8 -*-
# vi:si:et:sw=4:sts=4:ts=4

##
## Copyright (C) 2006 Async Open Source <http://www.async.com.br>
## All rights reserved
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
## USA.
##
"""
A short description about what this file implements ...
"""

Observe que as primeiras duas linhas do header são definições para os editores emacs e vim. Há também uma definição de um encoding para o python o que evita DeprecationWarnings em tempo de runtime e possibilita uma interpretação correta das strings dispostas no módulo.

Body

O corpo dos arquivos deverá ser organizado por grupos tal como demonstrado abaixo:


#
# Constants
#

TRUE = 1
FALSE = 0

#
# Base classes
#

Here we will define base classes.

#
# Adapters implementation
#

Adapters definition here.

Classes

O cabeçalho de cada classe conterá sempre uma breve descrição sobre a mesma no seguinte já conhecido formato:

"""
  Class description
"""

<<<Código>>>

NOTA: Deve haver um espaço em branco entra a docstring de uma classe e o começo do bloco de código