Skip to content

Commit

Permalink
docs: πŸ“[item 56] 곡개된 API μš”μ†Œμ—λŠ” 항상 λ¬Έμ„œν™” 주석을 μž‘μ„±ν•˜λΌ
Browse files Browse the repository at this point in the history
  • Loading branch information
Shinminjin committed Apr 14, 2024
1 parent d2ac7cc commit 490e4a7
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions _posts/effective-java/chapter8/2024-04-14-item56.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ tags: [μ΄νŽ™ν‹°λΈŒ μžλ°”]

**javadoc λͺ…λ Ήμ–΄ μ‚¬μš©**

```java
```shell
$ javadoc -d docs {file_name}.java
```

**ν•œκΈ€ μ‚¬μš©μ‹œ UTF-8둜 인코딩 ν•„μš”**

```java
```shell
$ javadoc -d docs {file_name}.java -encoding UTF-8 -charset UTF-8 -docencoding UTF-8
```

Expand Down Expand Up @@ -80,7 +80,7 @@ E get(int index);
![method](https://github.com/Shinminjin/Algorithm/assets/76575966/2ef89c3f-3c08-45fe-bd72-f79317514ab1)
- `<p>` : ν•˜λ‚˜μ˜ 문단을 λ§Œλ“¦, `<i>` : κΈ°μšΈμž„ κΌ΄

## **Javadoc 주석 νƒœκ·Έ**
## **μ›ΉνŽ˜μ΄μ§€μ— μ—†λŠ” Javadoc 주석 νƒœκ·Έ**

### **{@code}**

Expand All @@ -91,7 +91,7 @@ E get(int index);
### **{@literal}**

- νƒœκ·Έλ‘œ 감싼 λ‚΄μš©μ— ν¬ν•¨λœ HTML μš”μ†Œλ‚˜ λ‹€λ₯Έ μžλ°”λ… νƒœκ·Έλ₯Ό λ¬΄μ‹œν•œλ‹€.
- `{@code}`와 λΉ„μŠ·ν•˜μ§€λ§Œ μ½”λ“œ 폰트둜 λ Œλ”λ§ν•˜μ§€ μ•ŠλŠ”λ‹€.
- `{@code}`와 λΉ„μŠ·ν•˜μ§€λ§Œ μ½”λ“œμš© 폰트둜 λ Œλ”λ§ν•˜μ§€ μ•ŠλŠ”λ‹€.
- μ•„λž˜λŠ” < 기호λ₯Ό 주석에 포함 μ‹œν‚€κΈ° μœ„ν•΄ `@literal` νƒœκ·Έλ₯Ό μ‚¬μš©ν•œ μ˜ˆμ‹œλ‹€.

```java
Expand All @@ -110,7 +110,6 @@ E get(int index);
- μƒμœ„ νƒ€μž…μ˜ λ¬Έμ„œν™” 주석 일뢀λ₯Ό 상속할 수 μžˆλ‹€.

### **{@index}**

- μžλ°”9λΆ€ν„° μžλ°”λ…μ΄ μƒμ„±ν•œ HTML λ¬Έμ„œμ— 검색 κΈ°λŠ₯이 좔가됐닀.
- {@index} νƒœκ·Έλ₯Ό μ‚¬μš©ν•˜λ©΄ μžλ°”λ…μ΄ μƒμ„±ν•œ HTMLμ—μ„œ {@index}에 μƒ‰μΈν–ˆλ˜ μ΄λ¦„μœΌλ‘œ 검색이 κ°€λŠ₯ν•˜λ‹€.

Expand Down

0 comments on commit 490e4a7

Please sign in to comment.