클린 코드 - 주석,포맷팅

주석

관용적으로 사용되는 키워드

• TODO : 당장은 아니지만 다음에 해야 할 때
• FIXME : 치명적인 에러를 발생하는 코드는 아니지만 수정해야할 때
• XXX : 더 생각해볼 필요가 있을 때

# TODO : 객체의 책임 더 분리하기
class GrabStore:
	...
    	# FIXME: 반복문의 depth 줄이기
        def sell_food(self):
        	for food in food_list:
            for discount in discount_list:
            	...

 

포맷팅

Vertical Formatting

• 한 파일에 코드를 다 넣지 말고, 개념에 맞게 파일을 나눠서 사용

# fruit_store.py
class FruitesStore:
	...
    
# cumputer_store.py
class ComputerStore:
	...

 

• 다른 개념의 코드는 Spacing으로 분리하기
• 비슷한 개념의 코드는 붙여서 사용하기

def test_user_buy_product():
	user = User()
    product = Product()
    
    product.set_sold_out(True)
    user.get(product)
    
    assert result == "success"

 

Horizontal Formatting

• 한 줄에 코드를 다 넣기보단 변수 등을 활용해서 가독성 높이기
• 네이밍 잘해서 길이 줄이기

items = [Product("모니터"), Product("키보드")]
product_list.extend(items)