Naming Rule
1. 변수, 클래스명 : 명사(None)
class: FeatureExtract (X)
class: FeatureExtractor (O)
var: work (X)
var: worker (O)
JavaScript
복사
2. 변수, 클래스명 : 관사X, to(2)를 제외한 전치사 가능한 생략
var: a_cat (X)
var: cat (O)
var: the_number_of_worker (X)
var: num_workers (O)
class: Seq2seq
function: sentence_to_id()
var: char2id
JavaScript
복사
3. iterators : 단수와 복수 구분
items = [1,2,3,4,5]
for item in items: # 아이템들 중에 아이템
print(item)
Python
복사
4. 함수명 : 동사+명사
function: id() (X)
function: get_id() (O)
JavaScript
복사
5. Boolean 타입 변수 : is_boolean
•
is_ 접두사(prefix)를 사용
is_human = True # 사람인지 아닌지
is_animal = False # 동물인지 아닌지
is_exist = True # 존재하는지 안하는지
is_final_data = False # 마지막 데이터인지 아닌지
...
Python
복사
가독성 향상 Rule
주석은 설명하려는 구문에 맞춰 들여쓰기
// Good
function someFunction() {
...
// statement에 관한 주석
statements
}
JavaScript
복사
연산자 사이에는 공백을 추가
a+b+c+d // bad
a + b + c + d // good
JavaScript
복사
콤마 다음에 값이 올 경우 공백을 추가
var arr = [1,2,3,4]; //bad
var arr = [1, 2, 3, 4]; //good
JavaScript
복사
