Add comment

@@ -2,7 +2,6 @@ const express = require('express');
 const config = require('./API_config');
 const config = require('./API_config');
 const line = require('@line/bot-sdk');
 const line = require('@line/bot-sdk');
 const request = require('request');
 const request = require('request');
-
 const app = express();
 const app = express();
 
 
 //번역 api_url
 //번역 api_url
@@ -11,6 +10,15 @@ const translate_api_url = 'https://openapi.naver.com/v1/papago/n2mt';
 //언어감지 api_url
 //언어감지 api_url
 const languagedetect_api_url = 'https://openapi.naver.com/v1/papago/detectLangs';
 const languagedetect_api_url = 'https://openapi.naver.com/v1/papago/detectLangs';
 
 
+// API_config.js 의 형태는 다음과 같다.
+// const client_id = 'xxxx';
+// const client_secret = 'xxxx';
+
+// const line_channel = {
+//   channelAccessToken: 'xxxx',
+//   channelSecret: 'xxxx',
+// };
+
 // Naver Auth Key
 // Naver Auth Key
 //새로 발급받은 naver papago api id, pw 입력
 //새로 발급받은 naver papago api id, pw 입력
 const client_id = config.client_id;
 const client_id = config.client_id;
@@ -30,15 +38,19 @@ app.get('/', (req, res) => {
 
 
 // register a webhook handler with middleware
 // register a webhook handler with middleware
 app.post('/webhook', line.middleware(line_channel), (req, res) => {
 app.post('/webhook', line.middleware(line_channel), (req, res) => {
-	// webhook post 요청에 대해 promises를 전체 수행한다.
+	// webhook 요청에 대해 순차적으로 다음을 수행한다.
 	// 전체 수행은 순차수행이기 때문에 동기처리 필요 => async await 패턴을 사용한다
 	// 전체 수행은 순차수행이기 때문에 동기처리 필요 => async await 패턴을 사용한다
 	const promises = req.body.events.map(async (event) => {
 	const promises = req.body.events.map(async (event) => {
+		// 메세지의 속성을 확인하고 API connector를 만든다
 		let api_connector = await api_connect(event);
 		let api_connector = await api_connect(event);
+		// connector를 통해 언어 감지, 번역 target 언어를 설정한다
 		let options = await option_maker(api_connector, event);
 		let options = await option_maker(api_connector, event);
+		// 설정된 source 및 target으로 번역 결과를 저장한다
 		let result = await receive_result(options, event);
 		let result = await receive_result(options, event);
+		// 모든 작업이 끝나면 client api를 통해 reply를 진행한다.
 		client.replyMessage(event.replyToken,result);
 		client.replyMessage(event.replyToken,result);
 	})
 	})
-	Promise
+	Promise // promise all은 일괄 수행이 완료될 때 then이 수행된다
 	.all(promises)
 	.all(promises)
 	.then((result) => res.json(result))
 	.then((result) => res.json(result))
     	.catch((err) => {
     	.catch((err) => {
@@ -47,14 +59,15 @@ app.post('/webhook', line.middleware(line_channel), (req, res) => {
     });
     });
 });
 });
 
 
-// 이벤트 타입 검사 이후
 // language detector api url 및 client id, secret 을 담은 connector를 반환한다.
 // language detector api url 및 client id, secret 을 담은 connector를 반환한다.
 const api_connect = (event) => {
 const api_connect = (event) => {
     return new Promise((resolve, reject) => {
     return new Promise((resolve, reject) => {
+		// 이벤트 타입 검사
 		if (event.type !== 'message' || event.message.type !== 'text'){
 		if (event.type !== 'message' || event.message.type !== 'text'){
-		//언어 감지 option
+			// 비정상에 대한 reject 처리
 			reject(new Error('메세지 혹은, 텍스트가 아닙니다.'));		
 			reject(new Error('메세지 혹은, 텍스트가 아닙니다.'));		
 		} else {
 		} else {
+			// 정상요청에 대한 connector 생성 및 resolve
 			resolve({
 			resolve({
 				url : languagedetect_api_url,
 				url : languagedetect_api_url,
 				form : {'query': event.message.text},
 				form : {'query': event.message.text},
@@ -74,7 +87,6 @@ const option_maker = (api_connector, event) => {
 				let detect_body = JSON.parse(response.body);
 				let detect_body = JSON.parse(response.body);
 				//언어 감지가 제대로 됐는지 확인
 				//언어 감지가 제대로 됐는지 확인
 				console.log(detect_body.langCode);
 				console.log(detect_body.langCode);
-
 				// 3.zh-CN : 중국어 간체
 				// 3.zh-CN : 중국어 간체
 				// 4.zh-TW : 중국어 번체
 				// 4.zh-TW : 중국어 번체
 				// 5.es : 스페인어
 				// 5.es : 스페인어
@@ -116,16 +128,22 @@ const option_maker = (api_connector, event) => {
 					checker = false;
 					checker = false;
 					target = 'ko';
 					target = 'ko';
 				}
 				}
+				// 전송된 메세지가 한국어일 경우 default target은 영어이며 설정에 따라 바뀐다.
+				// 전송된 메세지가 한국어가 아닐 경우 모든 target language는 한국어가 된다.
 
 
 				let options = {}
 				let options = {}
+				// checker란 언어 번역시 옵션의 존재 유뮤이다. 사용자가 영어가 아닌 다른 언어의 번역을 원할 경우
+				// 뒤에 옵션 .xx 가 붙게 되며 checker 는 true가 된다.
 				if (checker)
 				if (checker)
 				{
 				{
 					options = {
 					options = {
 						url:  translate_api_url,
 						url:  translate_api_url,
+						// checker가 true이면 메세지 끝에 옵션이 붙기 때문에 번역시 이를 무시할 필요가 있다.
 						form: {'source':detect_body.langCode, 'target': target, 'text':event.message.text.slice(0,-3)},
 						form: {'source':detect_body.langCode, 'target': target, 'text':event.message.text.slice(0,-3)},
 						headers: {'X-Naver-Client-Id': client_id, 'X-Naver-Client-Secret': client_secret}
 						headers: {'X-Naver-Client-Id': client_id, 'X-Naver-Client-Secret': client_secret}
 					};
 					};
 				}
 				}
+				// 기타 옵션 없는 한 -> 영, 외국어 -> 한글 번역은 checker false
 				else{
 				else{
 					options = {
 					options = {
 						url:  translate_api_url,
 						url:  translate_api_url,
@@ -133,11 +151,12 @@ const option_maker = (api_connector, event) => {
 						headers: {'X-Naver-Client-Id': client_id, 'X-Naver-Client-Secret': client_secret}
 						headers: {'X-Naver-Client-Id': client_id, 'X-Naver-Client-Secret': client_secret}
 					}
 					}
 				}
 				}
+				// 모든 번역 준비를 마친 options 를 resolve 한다
 				resolve(options);
 				resolve(options);
 			}
 			}
 			else{
 			else{
-				// 예외처리
-				reject(new Error("request is failed"));
+				// language detection에 대한 예외 reject
+				reject(new Error("언어 감지 실패"));
 			}
 			}
 		})
 		})
     })
     })
@@ -148,6 +167,7 @@ const option_maker = (api_connector, event) => {
 const receive_result = (options, event) => {
 const receive_result = (options, event) => {
   	return new Promise((resolve, reject) => {
   	return new Promise((resolve, reject) => {
 		var result = { type:'text', text: ''};
 		var result = { type:'text', text: ''};
+		// 번역에 관련된 options 객체를 번역 API로 post요청
     	request.post(options, (error, response) => {
     	request.post(options, (error, response) => {
       	// Translate API Sucess
       	// Translate API Sucess
 			if(!error && response.statusCode == 200){
 			if(!error && response.statusCode == 200){
@@ -159,17 +179,16 @@ const receive_result = (options, event) => {
 				resolve(result);
 				resolve(result);
 			}
 			}
 			else{
 			else{
-				// 예외처리
-				result.text = '언어를 감지할 수 없습니다.';
+				// 번역 정상적으로 불가능시 reject 처리
+				result.text = '번역할 수 없는 언어입니다.';
 				client.replyMessage(event.replyToken,result);
 				client.replyMessage(event.replyToken,result);
-				reject(new Error("language was not detected"));
+				reject(new Error("번역 실패"));
 			}
 			}
   		})
   		})
 	})
 	})
 }
 }
 
 
+// app running
 app.listen(3000, function () {
 app.listen(3000, function () {
   console.log('Linebot listening on port 3000!');
   console.log('Linebot listening on port 3000!');
-});
-
-// 무조건 3글자 자르면 짧은글 씹힌다
+});
\ No newline at end of file