Emacs에서 (코드를 더럽히지 않고) 자신의 코멘트를 남기고 싶습니다.

코드를 읽고 쓸 때, 자신을 위한 약간의 코멘트를 남기고 싶을 때 있네요. 그러나 직접 코멘트를 쓰면 코드가 더러워져 귀찮습니다.

그래서 코드를 변경하지 않고 인라인으로 코멘트를 추가할 수 있는 package 를 만들어 보았습니다!
본체는 GitHub/phantom-inline-comment에 둡니다.

추가 (2019/05/05) : 코멘트의 지속성에 대하여

이게 뭐야?

소스 코드를 변경하지 않고 주석을 남길 수 있습니다.
(코멘트를 써도 소스 코드 자체에는 diff가 발생하지 않습니다)

무엇이 기뻐요?

이 package 는 코드를 더럽히지 않고 코멘트를 남길 수 있으므로, 예를 들어 코드를 굳이 쓸 때나 리뷰를 할 때, 복잡한 코드를 읽을 때 등에 자신용 코멘트를 부담없이 남길 수 있습니다.
또, 코드상에 직접 기입할 수 있으므로, 직감적으로 코멘트의 내용을 재확인할 수 있습니다.

「TODO: Rename this function!!」

"NOTE: Maybe this code will create a critical bug..."

설정

git clone 그리고 init.el 에 다음을 기술하기만 하면 됩니다.

(add-to-list 'load-path "YOUR PATH")
(require 'phantom-inline-comment)

사용법

댓글 추가/편집

M-x phantom-inline-comment커서 한 줄 아래에 주석을 추가/편집합니다.
명령 실행 후 편집용 buffer가 팝업되므로 거기에 주석을 입력합니다. 그런 다음 C-c C-c 에서 변경 내용을 적용하고 C-g 에서 변경 내용을 취소합니다.

댓글 삭제

M-x phantom-inline-comment-delete커서의 한 줄 아래에 있는 주석을 삭제합니다.

댓글 전체 삭제

M-x phantom-inline-comment-delete-all모든 buffer의 코멘트를 삭제합니다.

댓글 나열

M-x phantom-inline-comment-show-all모든 코멘트를 표시합니다.
표시된 파일 이름/코멘트에 커서를 대고 Enter를 치면 해당 위치로 점프합니다.

댓글 접기

M-x phantom-inline-comment-toggle-all모든 댓글을 한 줄로 접습니다.
다시 실행하면 접을 수 있습니다.

주의사항

overlay 를 사용하고 있으며 주석은 buffer 에 붙습니다(cf. Overlays ).
그 때문에 코멘트는 영속화되지 않고, Emacs 를 종료하면 코멘트는 사라져 버립니다. 그래서 어디까지나 간단한 메모 쓰기 용도로 사용하는 것이 베스트라고 생각합니다.

이에 대해서는, 이하의 코멘트 지속성 에 회피 방법을 기재했습니다.

코멘트 지속성

어디까지나 실험적인 기능입니다만, Emacs를 종료해도 코멘트를 영속화시킬 수 있습니다.

;; phantom-inline-comments を Emacs 終了時に保存します
(phantom-inline-comment-auto-save-mode t)

;; 保存した phantom-inline-comments をリストアします
(add-hook 'SOME-MODE-hook 'phantom-inline-comment-auto-restore-mode)

이 설정은 Emacs가 종료 될 때 주석을 데이터 파일 (기본값은 ~/.phantom-inline-comment)에 저장합니다. 그리고 코멘트가 쓰여진 파일을 다시 열면 코멘트가 부활합니다.