Notice
Recent Posts
Recent Comments
Link
일 | 월 | 화 | 수 | 목 | 금 | 토 |
---|---|---|---|---|---|---|
1 | 2 | 3 | 4 | 5 | 6 | 7 |
8 | 9 | 10 | 11 | 12 | 13 | 14 |
15 | 16 | 17 | 18 | 19 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 | 30 | 31 |
Tags
- Ajax
- Python
- jquery
- gradle
- 외국인 노동자
- Linux
- SQL
- 일본
- 개발자 이야기
- Java
- angularjs
- webflux
- SQLite
- mybatis
- spring boot
- Spring
- Eclipse
- RSocket
- Apache
- bootstrap
- maven
- xml
- swift
- build tool
- php
- JavaFX
- node.js
- pdo
- WebClient
- javadoc
- Today
- 122
- Total
- 3,456,555
슬기로운 개발자 생활
[Javadoc] 주석 HTML문 작성 본문
반응형
HTML문 작성
Javadoc으로 작성된 문장은 HTML 문으로 해석되어 표시된다. 반대로 말하면 HTML 문으로 작성해야 한다면, 태그가 아닌 문자 코드로 작성해야 한다. 예를 들어 "<"는 "<"로 작성해야 한다.
HTML 문장이기에, HTML 태그를 사용할 수 있습니다.
/**
* 주석은 <b>HTML문</b>으로 작성한다.
*/
HTML 태그를 사용할 수 있지만 클래스 및 패키지 이외의 부분에서 <h1>
과 <h2>
등과 같은 제목 태그는 사용하지 않는 편이 좋을거 같다.
쌤플
간단한 예제를 실습해 보도록 하자.
/**
* Javadoc <b>테스트</b>용 클래스
* <a href="http://www.devkuma.com" target="_blank">링크</a> 작성
* <p style="color : #ff0000">스타일 시트</p> 작성
*/
public class Sample03 {
/**
* <font color="#ff0000">사이즈</font> 설정
*
* @param width 폭
* @param height <font color="#0000ff">높이</font>
*/
public void setSize(int width, int height) {
}
}
위에 소스 코드를 "Sample03.java"라는 파일명으로 저장하고 저장된 디렉토리에서 다음과 같이 실행한다.
$ javadoc -d doc Sample03.java
"doc"디렉토리에 있는 "Sample03.html" 파일을 브라우저로 확인해 보자.
위와 같이 <b>
태그에 의한 강조와 <a>
태그로 링크, <p>
로 스타일 시트, <font color="#0000ff">
에 의한 색상의 지정이 잘 반영되는 것을 확인할 수 있다.
반응형
'IT 개발 > Javadoc' 카테고리의 다른 글
[Javadoc] @author 태그 (0) | 2019.10.20 |
---|---|
[Javadoc] 주석 필드에 대한 주석 작성 시에 주의점 (0) | 2019.10.20 |
[Javadoc] 주석의 구성 (0) | 2019.10.20 |
[Javadoc] Javadoc 문서 작성 (0) | 2019.10.20 |
[Javadoc] Javadoc 대상이 되는 주석 작성 방법 (0) | 2019.10.20 |
0 Comments