coding convention

BackEnd_Ash.log·2020년 2월 27일
0

파이썬

목록 보기
11/34

코드는 가독성이 너무나도 중요하다 .

가독성이 높은 코드는 내가 작성하지 않았어도 보면 이해하기 쉬운 코드가 가독성이 높은 코드이다.
물론 코드가 길어지거나 어쩔수없이 복잡하게 적어야할땐 할 수 없지만
최대한 코드를 간결하게 적으면서 가독성이 좋으면서 남이 봤을때도 알아봐야 좋은 코드이다.

  1. 깔끔한 코딩 스타일
  2. 간단하고 명료한 로직
  3. 명확한 명수 , 함수 , 클래스 등의 이름

위의 사항들이 잘 지켜진 코드가 가독성이 높은 코드이다.
책을 쓸때도 전문용어를 장황하게 적으면서 , 알기어려운 책은 좋은 책이 아니다 .

지금은 돌아가셨지만 노회찬 의원님이 말씀하실때 , 누구나 다 알아들을 수 있게 잘 풀어서 설명을 해주신다.
언어라는 것은 소통하기 위해서 만들어 졌다.
그럼 소통을 잘하는 사람이 언어를 잘하는것이고 ,
코딩라는것도 결국 언어이다.

물론 기본적인 사항은 각자가 알고 있어야하고 공부를 해야한다. ㅎㅎ

naming

변수 , 함수 , 클래스 등등 최대한 한눈에 그 목적을 이해할 수 있는 이름을 선택해야한다.
변수명만 봤을때 이 변수는 무엇을 하기위해 만들어졌는지 한눈에 알아볼수 있어야한다.

일반적으로 변수나 클래스는 이름이 명사로 이루어지며 함수는 동사이다.

변수나 클래스는 특정 정보나 resource 를 가지고 있는 역할을 하고 함수는 특정 기능이나 연산을 실행 하는 역할을 한다.

변수 , 클래스 == > 명사
메소드 , 함수 == > 동사

코드가 한줄에 너무 길게 있을때 ,

보통 제가 많이 하는 실수인데
한줄로 다 적을려는 습관이 있다.
조금더 코드를 줄이다 보면 한줄로 적을려고 하기도해서
한줄에 많은 코드를 작성하게 되는데
결코 좋은 코드가 아니다. 코드가 간결하다고해서 가독성이 좋은것은 아니다.

profile
꾸준함이란 ... ?

0개의 댓글