Комментарии для функции в Emacs

Я ищу способ генерировать и вставлять блоки комментариев заголовка над моими функциями в Emacs (в любом режиме), с автоматическим содержанием комментария по умолчанию на основе подписи функции (т.е. правильное количество заполнителей @param) .

Doxymacs — хороший кандидат. Но я предпочитаю другой способ работы без необходимых библиотек. Может ли кто-нибудь порекомендовать другие способы добавления умных комментариев к функциям в Emacs? Спасибо.

Изменить: Теперь я нашел это: http://nschum.de/src/emacs/doc-mode/, но кажется, что он не работает должным образом после того, как я требую его в своем .emacs и добавляю хук для js-режима. Разве он не поддерживает функции js?


person Boris    schedule 26.03.2012    source источник
comment
Вы имеете в виду функции в elisp или функции, которые вы редактируете в Emacs?   -  person Tim Landscheidt    schedule 27.03.2012
comment
Я имею в виду любые функции на любом языке программирования. Когда я использую eclipse, я набираю /** над первой строкой определения функции, комментарии типа: /** \n *@desc\n *@param\n *@return\n **/ будут автоматически сгенерированы. Кроме того, количество параметров будет основываться на сигнатуре функции.   -  person Boris    schedule 27.03.2012


Ответы (2)


Я не знаю ни одного универсального подхода.

Csharp-mode имеет определение, привязанное к / , которое пытается генерировать комментарии, подходящие для C#. Как это работает: каждый раз, когда вы вводите косую черту, проверяется, является ли она третьей косой чертой подряд. (В C# три косых черты используются для обозначения комментариев, создающих документацию). Если это третья косая черта, то она просматривает окружающий текст и вставляет соответствующий скелет или фрагмент комментария.

изображение

Он никоим образом не обобщается для поддержки javascript или других языковых синтаксисов. Но вы можете построить то, что хотите, если начнете с этого.

вот отрывок:

http://pastebin.com/ATCustgi

person Cheeso    schedule 07.05.2012
comment
Спасибо, Чисо. Хорошее предложение. :) - person Boris; 10.05.2012

Я использовал doxymacs в прошлом и нашел его полезным http://doxymacs.sourceforge.net/

person perogiex    schedule 03.04.2012