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 13, 2024
1 parent f3037f0 commit 0b0f4ab
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions _posts/effective-java/chapter8/2024-04-14-item56.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,17 @@ E get(int index);

**μƒμ„±λœ api λ¬Έμ„œ**
![method](https://github.com/Shinminjin/Algorithm/assets/76575966/2ef89c3f-3c08-45fe-bd72-f79317514ab1)
- `<p>` : ν•˜λ‚˜μ˜ 문단을 λ§Œλ“¦, `<i>` :κΈ°μšΈμž„ κΌ΄
- `<p>` : ν•˜λ‚˜μ˜ 문단을 λ§Œλ“¦, `<i>` : κΈ°μšΈμž„ κΌ΄

## **Javadoc 주석 νƒœκ·Έ**

### **`{@code}`**
### **{@code}**

- νƒœκ·Έλ‘œ 감싼 λ‚΄μš©μ„ **μ½”λ“œμš© 폰트**둜 λ Œλ”λ§ν•œλ‹€.
- νƒœκ·Έλ‘œ 감싼 λ‚΄μš©μ— ν¬ν•¨λœ HTML μš”μ†Œλ‚˜ λ‹€λ₯Έ μžλ°”λ… νƒœκ·Έλ₯Ό λ¬΄μ‹œν•œλ‹€.
- 주석에 μ—¬λŸ¬ μ€„λ‘œ 된 μ½”λ“œ μ˜ˆμ‹œλ₯Ό λ„£μœΌλ €λ©΄ `{@code}`λ₯Ό `<pre>`νƒœκ·Έλ‘œ κ°μ‹Έμž. `<pre>{@code ...μ½”λ“œ... }</pre>`

### **`{@literal}`**
### **{@literal}**

- νƒœκ·Έλ‘œ 감싼 λ‚΄μš©μ— ν¬ν•¨λœ HTML μš”μ†Œλ‚˜ λ‹€λ₯Έ μžλ°”λ… νƒœκ·Έλ₯Ό λ¬΄μ‹œν•œλ‹€.
- `{@code}`와 λΉ„μŠ·ν•˜μ§€λ§Œ μ½”λ“œ 폰트둜 λ Œλ”λ§ν•˜μ§€ μ•ŠλŠ”λ‹€.
Expand All @@ -100,16 +100,16 @@ E get(int index);
*/
```

### **`@implSpec`**
### **@implSpec**

- **ν•΄λ‹Ή λ©”μ„œλ“œ**와 **ν•˜μœ„ 클래슀 μ‚¬μ΄μ˜ 계약**을 μ„€λͺ…ν•œλ‹€.
- ν•˜μœ„ ν΄λž˜μŠ€λ“€μ΄ κ·Έ λ©”μ„œλ“œλ₯Ό μƒμ†ν•˜κ±°λ‚˜ super ν‚€μ›Œλ“œλ₯Ό μ΄μš©ν•΄ ν˜ΈμΆœν•  λ•Œ, κ·Έ λ©”μ„œλ“œκ°€ μ–΄λ–»κ²Œ λ™μž‘ν•˜λŠ”μ§€ λͺ…ν™•νžˆ 인지할 수 μžˆλ„λ‘ 도와쀀닀.

### **`{@inheritDoc}`**
### **{@inheritDoc}**

- μƒμœ„ νƒ€μž…μ˜ λ¬Έμ„œν™” 주석 일뢀λ₯Ό 상속할 수 μžˆλ‹€.

### **`{@index}`**
### **{@index}**

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

0 comments on commit 0b0f4ab

Please sign in to comment.