2022-11-30 TIL sparta

오늘 한 일(회고)

• 최종 프로젝트 아이디어 회의 진행했습니다.

• 주석 컨벤션을 정하기위해 찾아봤습니다.

  • PEP8 : 파이썬 개선 제안서, 파이썬 코드를 어떻게 구상할 지 알려주는 스타일 가이드.

  • 코드와 모순되는 주석은 없느니만 못하다! 항상 코드에 따라 갱신하여야 합니다!

  • 블록 코멘트(Block Comment)

    • 블록코멘트 뒤에 오는 코드 일부나 전체에 대한 내용을 작성합니다.

    # 이것은 다음 코드의 대한 주석입니다.
    some code...
    return

  • 인라인 코멘트(Inline Comment)

    • 인라인 주석의 경우 꼭 필요한 경우가 아니면 사용을 지양합니다.
    • 코드가 명백하지 않을 경우만 사용합니다.
    • 주석을 작성할 구문 사이 최소 2개의 공백, #문자와 작성할 내용사이 1개의 공백이 들어갑니다.

    # 너무 명확한 것을 주석으로 다는 예는 불필요합니다.
    x = x + 1    # X가 1 증가합니다.
    
    # 특정한 의미를 가질 때의 주석은 의미가 있습니다.
    x = x + 1    # 경계값에 대한 보상

  • 도큐먼트 스트링(Docstrings)

    • PEP257 참조

    • 함수에 주석을 달고 싶을 때 달수 있습니다.

    • 함수를 정의하는 줄, 다음 줄에 달아줍니다.

    • 다수의 문장으로 이루어진 Docstring

      • Google Python Style Guide

      # 다수의 문장으로 이루어진 docstring
      def add_two_numbers(a, b):
          """두 숫자의 합을 반환해주는 함수입니다.
      
          (자세한 설명이 필요하면 더 작성)
      
          Args:
              a (int): 더할 숫자
              b (str): 인자값의 대한 설명
          Returns:
              int: a와 b의 합
          """

      • 무슨 일을 하는 함수인가?
      • 인자에는 무엇을 받는가?
      • 결과값은 무엇인가?

    • 하나의 문장만 들어간 Docstring

      def add_two_numbers(a, b):
          """두 숫자의 합을 반환해주는 함수입니다."""

내일 할 일

• SA 작성 및 마무리