JavaDocs에서 "*/"를 인용하는 방법

StackOverflow https://stackoverflow.com/questions/631817

  •  08-07-2019
  •  | 
  •  

문제

꼭 포함시켜야 할 필요가 있어요 */ 내 JavaDoc 댓글에 있습니다.문제는 이 역시 댓글을 닫는 순서와 동일하다는 점이다.이것을 인용/이스케이프하는 적절한 방법은 무엇입니까?

예:

/**
 * Returns true if the specified string contains "*/".
 */
public boolean containsSpecialSequence(String str)

후속 조치:사용할 수 있을 것 같습니다 / 슬래시를 위해.유일한 단점은 텍스트 편집기에서 직접 코드를 볼 때 읽기가 쉽지 않다는 것입니다.

/**
 * Returns true if the specified string contains "*/".
 */
도움이 되었습니까?

해결책

HTML 이스케이프를 사용하십시오.

그래서 당신의 예에서 :

/**
 * Returns true if the specified string contains "*/".
 */
public boolean containsSpecialSequence(String str)

/ "/"문자로 탈출합니다.

Javadoc은 생성 된 HTML에 미확인 된 탈출 된 시퀀스를 삽입해야하며 브라우저에서 "*/"로 렌더링해야합니다.

매우 조심하고 싶다면 두 캐릭터를 모두 탈출 할 수 있습니다. */ 번역합니다 */

편집하다:

후속 조치 : 슬래시에 사용할 수 있습니다. 유일한 단점은 코드를 직접 볼 때 읽을 수있는 것이 아니라는 것입니다.

그래서? 코드를 읽을 수있는 요점이 아니며 요점은 코드에 대한 것입니다. 선적 서류 비치 읽을 수 있습니다. 대부분의 Javadoc 의견은 설명을 위해 복잡한 HTML을 포함합니다. HELL, C#의 동등성은 완전한 XML 태그 라이브러리를 제공합니다. 나는 거기에서 꽤 복잡한 구조를 보았습니다.

편집 2 :그것이 당신을 너무 귀찮게한다면, 당신은 인코딩을 설명하는 비 Javadoc 인라인 의견을 포함시킬 수 있습니다.

/**
 * Returns true if the specified string contains "*/".
 */
// returns true if the specified string contains "*/"
public boolean containsSpecialSequence(String str)

다른 팁

아무도 언급하지 않았습니다 {@정확한}. 이것은 또 다른 방법입니다.

/**
 * Returns true if the specified string contains "*{@literal /}".
 */

불행히도 당신은 탈출 할 수 없습니다 */ 한 번에. 몇 가지 단점을 사용하면 다음과 같은 수정이 수정됩니다.

유일한 단점은 텍스트 편집기에서 코드를 직접 볼 때 이것이 읽을 수 없다는 것입니다.

/**
 * Returns true if the specified string contains "*/".
 */

이것은 '올바른'솔루션이지만, 가독성을 위해서는 다음을 위해 갈 것입니다.

/**
 * Returns true if the string contains an asterisk followed by slash.
 */

엔티티를 사용하십시오 

*/

문서에서 "*/"로 표시됩니다.

나는 또한 당신이 다음과 같은 말 근처 어딘가에 라인 코멘트를 추가하는 것이 좋습니다.

// */ is html for */

완전성을 위해 내가 우연히 발견한 또 다른 방법은 다음과 같습니다.*와 / 사이의 출력을 변경하지 않는 HTML 마크업을 추가하세요. 

  /**
   * *<b/>/
   */

HTML 이스케이프 솔루션과 비교하면 이는 보기 흉한 해킹처럼 보이지만 HTML 출력에서도 올바른 결과를 산출합니다.

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top