TIL(07.08)

Seokhwan Yi·2020년 7월 7일
0

TIL

목록 보기
9/9

가독성이 좋은 코드를 위한 스타일 가이드

Python 스타일 가이드

Python의 경우 PEP8(Python Enhance Proposal 8)이라는 스타일 가이드가 있습니다.
Python 공식 스타일 가이드(일명: PEP8)
https://www.python.org/dev/peps/pep-0008/

Google Python 스타일 가이드
글로벌 IT 기업인 Google에서 사용하는 스타일 가이드입니다.
PEP8과 비교해서 가장 다른 점은 “Docstring”을 작성하는 법에 대해 좀 더 깊이 다루고 있습니다.
https://github.com/google/styleguide/blob/gh-pages/pyguide.md

JavaScript 스타일 가이드

JavaScript 표준 스타일 가이드
https://standardjs.com/

Airbnb JavaScript 스타일 가이드
https://github.com/airbnb/javascript

Google JavaScript 스타일 가이드
https://google.github.io/styleguide/jsguide.html

좋은 코드를 찾을 수 있는 곳

1. 라이브러리

좋은 코드는 어디서 찾을 수 있을까?
유명 개발자들의 라이브러리 내부의 코드를 염탐해보자.

Seaborn 라이브러리 - https://seaborn.pydata.org/tutorial.html
Pandas 라이브러리 - https://pandas.pydata.org/pandas-docs/stable/getting_started/10min.html

2. 개발 문서

라이브러리나 프레임워크를 만들 때도, '이렇게 쓰면 된다.' 라고 알려주는 문서들이 공식 개발 문서이다. 매우 신중하게 예시를 작성해서 공유하기 때문에 공식 문서를 읽어서 적용하는 습관을 들이면 좋다.

Python - https://docs.python.org/ko/3/
Javascript - https://developer.mozilla.org/ko/docs/Web/JavaScript/Guide

3. 커뮤니티

보통은 god googling 이지만, 개발자들끼리 여러방식으로 장단점을 고민하고 논의한 기록들이 있을거다. 보통 프로그래밍은 공유 문화가 잘 되어 있기 때문에, 좋은 사례와 이유 같은걸 적어둔 사이트, 블로그를 찾아보는것도 좋다.

보통 Best Practice 라고 검색을 해보면, 어떤게 좋은 코드인지 발견할 수 있을거다.

profile
위대한 한잔을 좋아 합니다.

0개의 댓글