moodle/lang/es/docs/coding.html
2003-07-07 20:39:52 +00:00

58 lines
2.6 KiB
HTML

<h2>Reglas generales de c&oacute;digo en Moodle<br>
</h2>
<h3>Reglas Generales<br>
</h2>
<ol>
<li>Todos los archivos deben utilizar la extensi&oacute;n .php.</li>
<li>Deben mantenerse todas las notas de copyright. Ud. puede colocar
la suya si es necesario.</li>
<li>Cada archivo debe incluir el config.php principal.</li>
<li>Cada archivo debe certificar que el usuario est&eacute;
correctamente autenticado, utilizando require_login() and isadmin(),
isteacher(), iscreator() o isstudent().</li>
<li>Todo acceso a la base de datos debe utilizar las funciones
incluidas en lib/datalib.php en cuanto sea posible --esto permite la
compatibilidad entre un amplio rango de bases de datos. Con esas
funciones es posible hacer casi todo. Cualquier otra sentencia
SQL debe ser: inter-plataforma, restringida a funciones
espec&iacute;ficas dentro del c&oacute;digo (a menudo un archivo
lib.php), y se&ntilde;alado con claridad.</li>
<li>Todas las cadenas deben ser traducibles --crear nuevos textos en
los archivos de "lang/en" y llamarlos utilizando get_string() o
print_string().</li>
<li>Todos los archivos de ayuda deben ser traducibles --crear nuevos
textos en los archivos de "lang/en/help" y llamarlos utilizando
helpbutton().</li>
</ol>
<p>&nbsp;</p>
<h3>Estilo de código</h2>
<ol>
<li>No utilice tabuladores. Use sangr&iacute;a consistente con 4
espacio.</li>
<li>Siempre se deben utilizar llaves para los bloques de
c&oacute;digo (aunque sean de una sola l&iacute;nea). Moodle usa este
estilo:
<p> <font color="#006600">if (</font><font
color="#0000cc">$quiz</font><font color="#006600">-&gt;</font><font
color="#0000cc">attempts</font><font color="#006600">) {<br>
&nbsp;&nbsp;&nbsp;&nbsp;if (</font><font color="#0000cc">$numattempts </font><font
color="#006600">&gt; </font><font color="#0000cc">$quiz</font><font
color="#006600">-&gt;</font><font color="#0000cc">attempts</font><font
color="#006600">) {<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</font><font
color="#0000cc">error</font><font color="#006600">(</font><font
color="#cc0000">$strtoomanyattempts</font><font color="#006600">, </font><font
color="#cc0000">"view.php?id=$cm</font><font color="#006600">-&gt;</font><font
color="#cc0000">id"</font><font color="#006600">);<br>
&nbsp;&nbsp;&nbsp;&nbsp;}<br>
}</font></p>
</li>
<li>M&aacute;s por venir... este documento a&uacute;n no est&aacute;
completo.</li>
</ol>
<p align="center">&nbsp;</p>
<hr>
<p align="center"><font size="1"><a href="." target="_top">Moodle
Documentation</a></font></p>
<p align="center"><font size="1">Version: $Id: faq.html,v 1.6
2003/03/30 13:54:28 moodler Exp $</font></p>