소스 코드에서 여러 줄 주석의 형식을 지정하시겠습니까(문서화용으로도)?

소스 코드에서 여러 줄 주석의 형식을 지정하시겠습니까(문서화용으로도)?

내가 찾고 있는 것은 다음과 같이 간단히 말할 수 있습니다.

문서에 사용하기 위해 C 소스 코드 주석의 형식을 (적어도 부분적으로) 자동으로 지정할 수 있는 기존 도구/방법이 있습니까?

저는 주로 C 주석을 처리하는 데 관심이 있지만 언어 독립적인 도구가 있으면 좋을 것입니다.

vim저는 IDE, 주로 Scite나 Geany와 같은 GUI 텍스트 편집기(불행히도 찾기 가 너무 어렵습니다) 를 사용하지 않는다는 점에 유의해야 합니다. emacs그래서 독립형 명령줄 도구(또는 오히려 Python 라이브러리)를 찾고 있습니다. 모든 무거운 작업을 수행하고 매우 간단한 실행 가능 스크립트가 명령줄 도구로 작동하도록 허용합니다. 또는 GUI 텍스트 편집기(또는 상대적으로 간단한 GUI 텍스트 편집기)에 대해 이러한 형식을 지정할 수 있는 플러그인입니다.


몇 가지 예를 들어 이를 확장해 보겠습니다.

이상적으로는 이것이 텍스트 편집기에서 다음과 같은 모드가 되기를 바랍니다. 여러 줄의 C /* ... */주석에 있는 경우 입력할 때 줄이 원하는 너비(80자)로 끊어지고 새 줄 주석 시작 부분에 자동으로 추가됩니다 *.

Ssite에는 다음이 있습니다.http://lua-users.org/wiki/SciteLineBreak확장 프로그램은 다음과 같이 작동합니다(전체 크기 애니메이션 gif를 보려면 클릭하세요):

따라서 "new"를 입력할 때만 작동하며, 다음과 같이 커서 앞에 텍스트가 있으면 실제로 줄바꿈을 결정할 수 없습니다.그래서 포스팅은:

...텍스트를 입력할 때 개행 문자를 삽입하지만 백스페이스 키를 누르거나 복사/붙여넣을 때는 삽입하지 않습니다.

...분명히 C 여러 줄 주석이 무엇인지 "알지" 못합니다 /* ... */.

따라서 "라이브" 및 "여러 줄 주석 인식"과 같은 GUI 텍스트 편집기 기능은 *줄 시작 부분에 삽입/삭제할 수 있고 복사/붙여넣기, 백스페이스 및 커서 앞의 텍스트를 처리할 수 있습니다. 정말 좋아요. 이렇게 작동하는 것이 있나요?


반면, 명령줄 도구가 텍스트 입력을 받고 서식이 지정된 텍스트 출력을 반환하는 "명령줄" 유형의 상호 작용이 있습니다. Scite와 같은 텍스트 편집기에서는 입력이 선택된 텍스트로 이 도구를 호출한 다음 텍스트 선택을 출력으로 바꾸는 Lua 스크립트 플러그인을 쉽게 생성할 수 있습니다.

Windows/Visual Studio 세계에는 다음과 같은 유료 플러그인이 있습니다.Visual Studio용 Atomineer Pro 설명서(발견을 통해doxygen 코드 주석을 작성하는 데 가장 좋은 도구나 기술은 무엇입니까 - ThinbugCTRL), 키보드 단축키 ++ 를 누른 후 SHIFT함수 서명을 기반으로 문서 주석 프레임워크를 생성할 수 있습니다 D.

Atomineer Pro 문서

명령줄 도구의 기능과 유사하게 텍스트 줄을 함수 서명으로 받아들이고 문서의 뼈대를 생성할 수 있습니다.강력한 산소(또는 문서 주석 및 함수 서명이 포함된 텍스트가 제공되는 경우 주석에 기존 텍스트를 유지하고 함수 서명에 대한 새 매개변수를 삽입하세요.) 그러면 좋을 것 같습니다. 비슷한 것이 있습니까? 나는 이와 같은 것을 찾는 데 어려움을 겪고 있습니다. 아마도 간단하지 않기 때문일 것입니다. 도구는 "여러 줄 주석 인식"뿐만 아니라 "프로그래밍 언어 인식"도 가능해야 합니다.

나는 그러한 명령줄 도구의 한 가지 가능성이 소스 코드 "예쁜 인쇄" 포맷터일 것이라고 생각했지만아스타일)내가 아는 한, 이전에는 일반적으로 댓글을 그대로 두었습니다. 그러나 비슷한 아이디어를 논의하는 이 포맷터를 찾았습니다.댓글 포장 · 이슈 #265 · 더 예뻐요/더 예뻐요 · GitHub- 그러나 아직 구현되지 않은 것 같습니다. Atom 텍스트 편집기 플러그인 데모 스크린샷이 있습니다(전체 크기 애니메이션 gif를 보려면 클릭하세요).

내가 알 수 있는 한, 이것은 줄 바꿈만 하고 서식이 사라지면 주석 텍스트를 대체하기 위해 플러그인이 호출됩니다. 플러그인은 블록을 형성하는 여러 개의 한 줄 주석도 인식할 수 있습니다.

그래서 내 옵션 중 하나는 Atom을 사용하는 것입니다.JavaScript 주석 형식 지정C 주석 형식을 지정하기 위한 플러그인. 단, Atom을 사용해 본 결과 약간 압도적이었습니다(거의 IDE처럼 느껴짐). 이것이 바로 제가 독립 실행형 명령줄 도구에서 플러그인 기능을 사용하는 것을 선호하는 이유입니다.

그렇다면 문서 프레임을 생성할 수 없는 경우에도 텍스트 입력을 허용할 수 있는 명령줄 도구가 있습니까? 여러 개의 한 줄 주석 블록 또는 여러 줄 주석 블록을 인식하고 문자 너비에 맞게 형식을 지정하고(주석의 기존 들여쓰기 처리 방법을 사용자 정의할 수 있음) 새로 형식이 지정된 텍스트를 출력합니까?

관련 정보