CODEWITHSUNDEEP
emacscommentselispdoxygendoc
Boris
Boris

Reputation: 565

Comments for Function in Emacs

I'm looking for a way to generate and insert header comment blocks above my functions in Emacs (in any mode), with the default contents of the comment automatically based on the function's signature (i.e. the correct number of @param place-holders).

Doxymacs is a nice candidate. But I prefer another way works without the necessary libs. Can anyone recommend some others ways for adding smart comments for functions in Emacs? Thanks.

Edit: Now I found this: http://nschum.de/src/emacs/doc-mode/, but it seems that it does not work well after I require it into my .emacs and add hook for js-mode. Doesn't it support js functions ?

Upvotes: 2

Views: 1520

Answers (2)

Cheeso
Cheeso

Reputation: 192517

I don't know of any general-purpose approach.

Csharp-mode has a defun that is bound to / , which tries to generate comments appropriate for C#. The way it works: Every time you type a slash, it looks to see if it is the third slash in a row. (In C#, three slashes are used to denote comments that produce documentation). If it is the third slash, then it looks at the surrounding text and inserts a comment skeleton or fragment that is appropriate.

image

It is not generalized in any way to support javascript or other language syntaxes. But you might be able to build what you want, if you start with that.

here's the excerpt:

http://pastebin.com/ATCustgi

Upvotes: 2

perogiex
perogiex

Reputation: 515

I've used doxymacs in the past and I've found it useful http://doxymacs.sourceforge.net/

Upvotes: 0

Related Questions