Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: susa 함수에 jsdoc을 추가합니다. #250

Merged
merged 4 commits into from
Sep 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/two-ravens-end.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"es-hangul": patch
---

docs: susa 함수에 jsdoc을 추가합니다.
26 changes: 26 additions & 0 deletions src/susa/susa.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,32 @@
import { hasProperty } from '../_internal';
import { SUSA_MAP, SUSA_CLASSIFIER_MAP } from './constants';

/**
* 숫자를 순 우리말 수사로 변환합니다. 주어진 숫자가 0보다 크고 100 이하일 때 유효합니다.
*
* @remarks
* - **수사**란 숫자를 나타내는 우리말 단어입니다. [자세히 알아보기](https://ko.dict.naver.com/#/entry/koko/d0ce2b674cae4b44b9028f648dd458b0)
* - **수관형사**는 사물의 수나 양을 나타내는 관형사입니다. ‘두 사람’의 ‘두’, ‘세 근’의 ‘세’ 따위를 뜻 합니다. [자세히 알아보기](https://ko.dict.naver.com/#/entry/koko/c513782b82554ff499c80ec616c5b611)
*
* @param num 숫자를 입력합니다.
* @param classifier 수관형사를 사용할지 여부를 입력합니다. 기본값은 false입니다.
* @returns 변환된 수사를 반환합니다.
*
* @example
* susa(1); // '하나'
* susa(2); // '둘'
* susa(11); // '열하나'
* susa(21); // '스물하나'
* susa(99); // '아흔아홉'
* susa(100); // '백'
* susa(1, true); // '한'
* susa(2, true); // '두'
* susa(11, true); // '열한'
* susa(20, true); // '스무'
* susa(21, true); // '스물한'
*
* @see https://es-hangul.slash.page/docs/api/susa
*/
Comment on lines +27 to +29
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BO-LIKE-CHICKEN 안녕하세요, 고민되는 지점이 있어서 멘션드리게 되었어요
제가 수사랑 수관형사가 뭔지 잘 몰라서, 결국 수사가 뭔지 수관형사가 무엇인지 검색해볼 것 같다는 생각이 들더라구요
@see 수사? https://ko.dict.naver.com/#/entry/koko/d0ce2b674cae4b44b9028f648dd458b0

이런 링크도 첨부하는 것이 좋을지 고민됩니다!
cc @okinawaa

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

링크를 제공해주는 것은 너무 좋은 친절함 같지만, 링크를 전달하는 방식에서 이런 아이디어를 제안드려요 🙇🏻‍♂️

  1. @see 태그에서는 es-hangul에서 제공하는 docs로의 링크만 제공하는 것이 좋을 것 같아요
  2. "한글"이라는 복잡한 도메인의 특성상 앞으로도 "한국인도 어려운 도메인 지식"을 만나게 될텐데 다음과 같은 방식으로 제공해주면 어떨까해요

이렇게 제공하게되면 어려운 한글 도메인에 대한 설명 뿐만 아니라 의문을 가질 수 있는 함수의 제한(왜 1~100 까지만 지원하지?)에 대해서도 설명해 줄 수 있을 것 같아요 🙂

Screenshot 2024-09-15 at 9 31 45 PM

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

감사합니다 !!! 너무 좋네요!!! 🙇

export function susa(num: number, classifier?: boolean): string {
validateNumber(num);
return classifier ? getClassifierWord(num) : getNumberWord(num);
Expand Down