]> git.llucax.com Git - z.facultad/75.42/plaqui.git/blob - docs/coding_style.txt
- Se modifica el logo para tener una tipografia mas copada. Ahora el XCF fue
[z.facultad/75.42/plaqui.git] / docs / coding_style.txt
1 $Id$
2
3 Todo lo que es interfaz (clases, metodos, atributos, funciones, tipos de datos
4 en general) van en inglés.
5
6 Documentacion (incluido comentarios) en castellano.
7
8 Métodos de acceso y escritura de atributos publicos: get_<atributo>(),
9 set_<atributo>.
10
11 Nombre de clases: tipo Java.
12         class MiClase: public MiPadre {
13                 private:
14                         int atributo;
15                 public:
16                         int get_atributo(void);
17                         void set_atributo(int _atributo);
18         };
19
20 Nombre de métodos: tipo STL (con parametros que empiezan con '_').
21         virtual void mi_metodo(int _mi_entero) const = 0;
22
23 Nombre de atributos: idem métodos.
24
25 General:
26         - Se usan TABs para identar solamente.
27         - Llaves en la misma línea.
28                 if (algo == otro) {
29                         // codigo
30                 } else {
31                         // otra cosa
32                 }
33
34 Extension de archios :
35   - cpp : source
36         - h   : headers
37         - png : imagenes
38
39 Diseño GUI:
40  Este pequeño apartado pretende sugerrir algunos detalles de como nombrar
41  los widgets en el glade para luego hacer mas facil la lectura del codigo
42  final y evitar algunos problemas.
43  La propuesta es nombrar todo Widget que se necesite acceder o al que se le debe
44  programar un callback de la siguiente forma :
45    <pre>_<nombre widget>
46  Donde pre podria ser :
47    - btn : boton
48          - txt : entry (caja de texto)
49          - cmb : combo box
50          - rdo : radio button
51          - img : imagenes
52          - draw : drawing areas
53          - mnu : para los menues
54
55          y asi puede seguir la lista. Un caso particular podria ser el menu.
56          Si tenemos por ejemplo :
57            Archivo   Edicion
58                    Salir    Copiar
59                                   Pegar
60
61         Se podrian nombrar como :
62         mnu_file             mnu_edit
63           mnu_file_exit        mnu_edit_copy
64                                      mnu_edit_paste
65
66         Puede resultar largo, pero por experiencia es mas comodo al trabajar en el
67         codigo y para leerlo. Da una sensacion clara de donde esta cada cosa y de que
68         tipo es widget se trata.
69