Chapter3.2 - 사용자가 에러 메시지를 제대로 쓰는 법 사용자 에러에 대처하는 메시지 오류에 내용과 오류의 원인을 같이 알려줘야 사용자가 대처 가능함 에러를 해결할 방법도 정확히 알려줘야 함 에러 내용: 오류로 인한 문제와 종류 에러의 원인: 오류를 발생시킨 직접적이고 근본적인 원인 에러 해결 방법: 사용자가 오류를 해결할 가장 쉽고 빠른 방법 에러 메시지를 보여주는 순서 에러 해결 방법 → 에러 원인 → 에러 내용 오락가락 메시지와 버튼 메시지 버튼에 '예', '아니오'를 쓰는 것 보다 특정 행동에 대한 단어(ex. 페이지에서 나가기)를 사용하는 것이 더 좋음 참고문헌: 개발자의 글쓰기
Chapter3.1 - 에러 메시지를 쓰기 전에 에러부터 없애자 친절한 404, 불친절한 404 구글, 위키피디아의 경우 간단하게만 에러페이지 출력 다음이나 YES24의 경우는 친절하게 안내 404 에러가 죄송할 일인가? 404 에러를 만나는 경우 사용자가 URL을 잘못 입력한 경우 사용자가 링크를 클릭했으나 해당 페이지가 없는 경우 이 경우는 개발자가 죽은 링크를 처리하지 않은 것 깨진 링크는 개발자의 책임이다 브로큰링크체크닷컴 구글 서치콘솔을 이용하여 깨진 링크 확인 가능 개발자용 에러 메시지와 사용자용 에러 메시지를 분리하자 사용자에게 보여지는 메시지와 개발자용 메시지를 분리하여 정의하기
Chapter2.5 - 다른 개발자를 배려하는 주석 쓰기 코드는 의미를, 주석은 의도를 개발자가 의도를 전달하는 이유는 다른 개발자를 위한 것 letsEatSomething() // 내가 배가 고픈 상황 letsEatSomething() // 네가 배가 고픈 상황 letsEatSomething() // 내가 심심한 상황 주석의 반복 문서를 처음부터 보는 경우는 반복이 필요가 없을 것임 특정 부분만 검색해서 확인하고자 할때는 주석이 필요할 것임 독자에 따라 작성하는 것이 좋음 주석의 발췌와 요약 중요한 부분을 뽑으려면 덜 중요한 것을 빼야함 예시 // 사용자가 레벨업하려면 로그인을 10회 이상하고 게시물을 5개 이상 작성해야 한다. if(user.getLoginCount() >= 10 && user.get..
Chapter2.4 - 좋은 코드에는 주석이 없다? 이름을 잘 지으면 주석을 줄일 수 있다 이름이 주석을 대신할 수 있도록 // bad example // 스크린 최대 높이를 480으로 지정 int h = 480; // 사용자 유형을 분류해서 등급 값을 리턴 levelUser(); // good example int screenHeightMax = 480; classifyUserAndReturnClass(); 처음부터 주석 없이 코딩하는 연습을 하자 JSON에는 주석을 달 수 없었음 // 요청에 대한 성공/실패 여부 구분 "isRequestSucess": true, // 잘못된 이메일 주소 형식, 추가하지 않음 "noCreatedBecauseWrongEmail": [ ] 주석이 필요한 때도 많다 upda..
