Re: Modern Conventions for Emacs Lisp files?

[Thorsten Jolitz]

"Pascal J. Bourguignon" <address@hidden> writes:

> Stefan Monnier <address@hidden> writes:
>
>>> 1. File structuring with outcommented Org-mode headlines (;; * Headline)
>>
>> There is already a standard for that:
>>
>>    ;;; Headline
>>    ;;;; SubHeadline
>>    ;;;;; SubSubHeadline
>
> But the lisp convention is the opposite:
>
> ------------------------------------------------------------------------
> ;;;; -*- mode:lisp -*-
>
>
> ;;;;
> ;;;; File comment
> ;;;;
>
> ;;;
> ;;; Section comment
> ;;;
>
> (defun code ()
>   ;; indented comment
>   (form)                 ; inline comment
>   (form2)                ; long inline comment
>   ;; indented comment
>   (form3))
>
> ------------------------------------------------------------------------

If thats true (and I think it actually might be) it would be a very
inconvenient convention, because one would need to know the number of
heading levels in advance, and would have to change all other headers if
a new level is introduced at the bottom:

,-------------------------------------------
| > ;;;; -*- mode:lisp -*-     ; * level 1
| >
| > ;;;;
| > ;;;; File comment          ; * level 1
| > ;;;;
| >
| > ;;;
| > ;;; Section comment        ; ** level 3
| > ;;;
`-------------------------------------------


,----------------------------------------------
| > ;;;;; -*- mode:lisp -*-       ; * level 1
| >
| > ;;;;;
| > ;;;;; File comment            ; * level 1
| > ;;;;;
| >
| > ;;;;
| > ;;;; Section comment          ; ** level 2
| > ;;;;
| >
| > ;;;
| > ;;; Subsection comment        ; *** level 3
| > ;;;
`----------------------------------------------

--
cheers,
Thorsten