Item74. 메서드가 던지는 모든 예외를 문서화하라 #120
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
delmaSong
reviewed
Mar 20, 2021
10장_예외/item74.md
Outdated
Comment on lines
1
to
2
| # 메서드가 던지는 모든 예외를 문서화하라 | ||
|
|
delmaSong
approved these changes
May 16, 2021
ehgud0670
reviewed
May 19, 2021
|
|
||
| <br> | ||
|
|
||
| 이렇게 주석으로 문서화를 진행해놓을 경우, `makJuice()`를 호출하는 사용자는 해당 내용을 보고 어떤 경우에 어떤 에러가 발생되는지 쉽게 파악할 수 있게 될 것입니다. |
There was a problem hiding this comment.
Suggested change
| 이렇게 주석으로 문서화를 진행해놓을 경우, `makJuice()`를 호출하는 사용자는 해당 내용을 보고 어떤 경우에 어떤 에러가 발생되는지 쉽게 파악할 수 있게 될 것입니다. | |
| 이렇게 주석으로 문서화를 진행해놓을 경우, `makeJuice()`를 호출하는 사용자는 해당 내용을 보고 어떤 경우에 어떤 에러가 발생되는지 쉽게 파악할 수 있게 될 것입니다. |
=> 철자 수정하였습니다! 😁
|
|
||
| <br> | ||
|
|
||
| 또한 `public` 메서드의 경우 필요한 전제조건을 문서화해서 남겨 놓아야 하고, |
There was a problem hiding this comment.
자바 언어의 public 이라면, 스위프트의 경우에는
public,open메서드- public 또는 open 클래스의
internal메서드
도 문서화해서 남겨 놓아야겠습니다(UIKit나 Foundation을 보고 말씀드립니다).
이처럼 Swift의 경우에는 어떤 접근 제한자의 메서드를 문서화해야 하는지 같이 내용 추가되면 좋을 것 같아요.
dev-Lena
approved these changes
May 25, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
제목과 내용이 같습니다.
메서드가 예외를 던질 경우 해당 메서드 (특히 public)에는 주석을 달아 어떤 상황에 어떤 예외를 던지는지 작성해야한다는 용법입니다.
추가적으로 작성할 것이 있으면 일요일(3/20)전까지 수정하여 올리도록 하겠습니다.