핵인싸 개발자의 길/트레바리 활동(2019.8~2020.07)
현재까지 피드백 받은 내용 정리
Hello이뇽
2019. 9. 16. 00:08
지금까지 트레바리 안에서 작업한 내용에 대해 받은 피드백 정리
# 코드 리뷰
파일 명, 클래스 명, 변수 명을 더 직관적으로 일관성있게 작성
- 변수명은 무조건 카멜방식
- array 변수명은 복수형으로.
- API 함수 이름은 결과 데이터로 표현하는 것보다, 실행되는 기능을 표현하는 방식으로.
ex. namesData() - (X), getNames() = (O)
# 매뉴얼 제작 리뷰
- 해당 매뉴얼을 사용자들이 언제 보고 싶을지를 생각할 것
- 최대한 상세하게 작성도 좋지만, 매뉴얼 변경사항에 대한 유지보수가 쉽도록
(불필요한 사진, 도형은 삭제) - 하나의 내용을 여러 슬라이드로 나누지 말고, 하나의 슬라이드로 한 눈에 확인할 수 있도록.
더욱 더 신경 쓰자~!!
반응형