Doxygen 스타일 주석을 HTML로 변환하는 JavaScript 스 니펫

Question

관련하여 이 질문, 단일 독소 댓글을 HTML로 변환하기 위해 JavaScript 코드 스 니펫/라이브러리를 알고 있는지 궁금하십니까?

예를 들어,

/** This is a comment block
 *
 * \b bold text
 * \i italic text
 */

다음과 같은 것으로 변환됩니다.

<p>This is a comment block</p>
<p><b>bold</b> text</p>
<p><i>italic</i> text</p>

Doxygen의 다른 형식 관련 태그와 유사합니다.

내가 찾았 어 이것 이미, 내가 직접 구현해야한다면 좋은 출발점 인 것 같습니다. 그러나 아마도 완전한 프로젝트가 없을 것입니다 :-)

그래서 제안을 환영합니다!

Answer 1

최소한 기존 도구/코드베이스 활용 부분 당신이 원하는 것은 최선의 방법입니다. 파싱은 쉬운 문제가 아니며, 특히 여러 언어를 처리하는 경우 특히 코드에서 독소 댓글을 찾는 것입니다. 빠른 검색은 끔찍한 명백한 프로젝트를 시작하지 않았지만, 필요한 경우 직접 만들려면 Doxygen 코드베이스 자체로 시작하는 것이 좋습니다. 오픈 소스이며 사용 가능합니다 SVN 또는 직접 다운로드. Doxygen은 C ++로 작성되었지만 파서의 행동 (아마도 특정 언어에 대해서만)을 따라갈 수 있다면 많은 작업을 절약하고 코너 케이스가 누락 된 경우 등을 방지 할 수 있습니다. 해결책, 그리고 그것이 당신만이 그것을 사용하는 경우, 또는 당신이 다른 사람들을 위해 그것을 지원할 수있는 경우. 행운을 빕니다!

Answer 2

 function commentToTag(comment) {
 
 var header = null;
 var commentHtml = '';
 
 comment.split('\n').forEach(function (i) {
 		var array = i.split(' ');
    do {
 				var index = array.indexOf('');
				if (index !== -1) array.splice(index, 1);
 				index = array.indexOf('');
    } while (index !== -1);
    do {
 				var index = array.indexOf('*');
				if (index !== -1) array.splice(index, 1);
 				index = array.indexOf('*');
    } while (index !== -1);
    do {
 				var index = array.indexOf('/**');
				if (index !== -1) array.splice(index, 3);
 				index = array.indexOf('/**');
    } while (index !== -1);
    do {
 				var index = array.indexOf('*/');
				if (index !== -1) array.splice(index, 2);
 				index = array.indexOf('*/');
    } while (index !== -1);
    if (array.length === 0) return;
    if (header === null) {
    		header = "<p>" + array.join(' ') + "</p>\n";
        return;
    }
    const tag = array.splice(0, 1);
    commentHtml += "<p><"+tag + ">"+array.splice(0,1)+"</" +tag+ ">" + array.join(' ') + '</p>\n';
    
    
 });
 return header + commentHtml;
 
 }
 
 var comment = `/** This is a comment block
 *
 * \i bold text
 * \i italic text
 */`;
 console.log(commentToTag(comment));