코드는 너만의 비밀 다이어리가 아니야

최근에 들었던 말 중에 제일 감명 깊은 말이었음

당연한 거지만 현직 개발자면 모두가 이해할 수 있는 코드를 짜야됨

알고리즘 문제 풀 때처럼 '일단 돌아감' 코드라던가 숏코딩하면 안 된다는 거임

 

이걸 지금까지 무시하고 있었음 현직자가 아니라 학생이라는 이유로

 

1. Python style pep8

2. Type hint

3. 주석처리

 

이 셋이 지금까지 배운 중요한 요소들임

코드 설명을 생활화하자

 

그리고 방금 깨달았는데 주석처리는 단순한 주석처리가 아니였음 

Docstring. 

 

https://thatascience.com/learn-python/comments-and-docstrings-in-python/

The No 1 Ultimate Guide to Comments and Docstrings in Python | thatascience

 

Docstring 과 Annotation (주석)의 차이

 

 

Docstring 이란:

소스 코드에 포함된 문서 (리터럴 문자열, 로직의 일부분을 문서화)

- 이유가 아니라 설명

- 주석이 아닌 코드의 특정 컴포넌트(모듈, 클래스, 메서드, 함수) 에 대한 문서화

 

그래서 문서화를 왜하냐:

다른 사람이 읽기 때문.

'가치 있는 문서를 만들기 위해'

소프트웨어는 단순한 코드가 아니다.

 

sphinx 를 사용하면 docstring가져와서 문서화된 페이지도 만들어 줌. 

 

이거 진짜 바보같긴한데 

 

class Shift_cypher:
"""
ssss
"""
    def __init__(self): 
        self.cypher: str = ''

---

이지랄하면 에러뜸ㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋ

당연한데 indentation 맞춰야해서

진짜 알아차리고 개쪽팔렸음

 

 

ㅓㅑㅣ아ㅣㅁ우ㅏㅣ위ㅏㅓㅣ존나간지나

진짜 이걸 지금 안게 너무 부끄러워짐. 너무 잼민이같음. 지금이라도 알아서 다행이지