[Javascript] 주석 이렇게 달아볼까?

 

주석을 자동완성 할때 참고 할 수 있도록 사용하자.

	interface LoginFormData {
		userId: string
		password: string
	}

	const handleSubmit = (params: LoginFormData) => {
		console.log('submit!')
	}

	handleSubmit({ userId: 'userid', password: '1234' })

먼저 위와 같은 코드가 있다고 할 때의 함수 호출 시 나타나는 것은 다음과 같다.

만약에 JsDoc 주석 ( /** */ ) 을 달아놓으면 

	/**
	 * 로그인 폼 전송
	 * @paramType LoginFormData
	 * @param userId string
	 * @param password string
	 */
	const handleSubmit = (params: LoginFormData) => {
		console.log('submit!')
	}

	handleSubmit({ userId: 'userid', password: '1234' })

해당 함수에 대해 많은 정보를 더 얻을 수 있다.