Elisp(Emacs Lisp) - Curso Parte 4: Guía de convenciones para programas en Elisp

Vale, a lo que me refiero como guía de convenciones es una serie de cosas que no son obligatorias, pero sí recomendables, pues como ya explique en la parte anterior, para lo cual el programa debería ser hecho teniendo estas líneas

Principio del programa

;;; Package --- nombre del programa

En primer lugar, empezamos el programa con un comentario que en Elisp se añaden usando este signo ; el punto y coma solo con uno ya basta para un comentario pero para este contexto lo haremos con ;;; el signo repetido 3 veces.

Luego la siguiente línea será así:

;;; Commentary:

Y abajo puedes poner un comentario sobre lo que hace el programa, por ejemplo, pero tampoco quiere decir que esa sea la única forma para poner los comentarios

Luego iria esta linea:

;;; Code:

Después de esta línea iría el código fuente del programa

Después del código

Después del código fuente del programa hay que colocar lo siguiente

;;; nombre-del-programa.el ends here.
(provide 'nombre-programa)

La primera parte indica que el archivo acaba aquí que el archivo elisp acaba aquí, luego la parte (provide 'nombre-programa) es parte de las convenciones y no se considera que el archivo está completo hasta que no está ahí, según yo creo provide como su propio nombre provee en este caso al programa para que si otro programa lo requiere puedas acceder a ello usando (require 'nombre-programa) en tu configuración de Emacs o en otros programas.

Ejemplo

Ejemplo de código elisp usando las convenciones aquí descritas:

;;; Package --- ejemplo
;;; Commentary:
;; Esto es un programa que muestra la palabra ejemplo en la barra del buffer cuando se solicita
;;; Code:

(defun show-example ()
    "Mostrar la palabra ejemplo"
    (interactive)
   (message "Ejemplo"))

;;; ejemplo.el ends here
(provide 'ejemplo)

Más o menos así quedaría el código final aplicando las convenciones aquí dichas, aunque claro como podéis ver, esto es un ejemplo muy pequeño.

Aquí acabamos esta cuarta parte del curso de Elisp, en la próxima parte veremos los condicionales

← Anterior
Siguiente →

4 Me gusta