ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • 1. 이름에 정보를 담아라
    Technique/Readable Code 2015. 12. 8. 11:58
    반응형

    ■ 특정한 단어를 사용하라

       - 상황에 따라 Get대신 Fetch나 Download를 사용하는 것이 나을 수 도 있다.

    ■ 꼭 그래야 하는 이유가 없드면 tmp 나 retval과 같은 보편적인 이름의 사용을 피하라

       - 제일 뜨끔햇다... 변수명 선언에 신경 써야 겟다...

    ■대상을 자세히 묘사하는구체적인 이름을 이용하라

      - ServerCanStart()는 CanListenOnPort()에 비해 의미가 애매 모호 하다

    ■ 변수명에 중요한 세부 정보를 덧붙여라

      - 예를 들어 밀리초의 값을 저장하는 변수 뒤에 _ms를 붙이거나 이스케이핑을 수행하는 변수 앞에 raw_를 붙이는 것

        리턴 되는 값이 일정하거나 정해진 경우 _char라던지 _int라던지 붙여주면 좋을거 같다. 야리스기 해도 불편하지만 상황에 따라

    ■ 사용 범위가 넓으면 긴 이름을 사용하라

      - 여러 페이지에 걸쳐서 사용되는 변수의 이름을 하나 혹은 두개의 짧은 문자로 구성해 의미를 알아보기 힘들게 짓지 말라, 

        다만 적은 분량에서 잠깐 사용되는 변수명은 짧을 수록 좋다

    ■ 대문자나 밑줄 등을 의미 있는 방식으로 활용하라

      - 클래스 멤버를 로컬 변수와 구분하기 위해 _ 를 붙여도 된다.

        나 같은 경우에는 private변수는 _로 시작하게 하고 있다.



    ■ 오해 할수 없는 변수 명을 선택해라

       언제나 의미가 오해되지 않는 이름이 최선의 이름이다.

       작성된 코드를 읽는 사람은 그 이름을 다른 뜻이 아닌 작성자의 의도했던 대로 이해 해야한다. 

       이름을 선택 하기 전 항상 최악의 경우를 가정하고 이름의 의미가 잘못 이해되는 가능성을 고려해봐야 한다.

       상한과 하한 일 정할땐 max_, min_

       경계를 포함 한다면  first_, last_

       시작만 포함하고 마지막을 배제한다면 begin_, end_

       참, 거짓을 드러내기 위해 is_, has_  

       일반 사람들이 특정하기 쉬운 단어는 사용에 주의해야한다 get(), size()같은 것들  을 조심하도록

    반응형

    'Technique > Readable Code' 카테고리의 다른 글

    6. 변수와 가독성  (0) 2015.12.10
    5. 거대판 표현을 잘게 쪼개기  (0) 2015.12.10
    4. 흐름제어  (0) 2015.12.10
    3. 주석  (0) 2015.12.09
    2. 미학 - 읽기 편한 코드 작성  (0) 2015.12.09

    댓글

Designed by Tistory.