"코딩 스타일", "명명 규칙"및 "코드 문서화"

Question

정말이 질문에 stackoverflow 맞는 및 너무 미안해 알지 못합니다. 당신이 나에게 그러한 질문을 어디서해야하는지 알려주면 정말 감사 할 것입니다.

이 항상 나를 귀찮게 개발의 머리와 같은 작은 회사에서 작업 :

얼마나해야 내가 "코딩 스타일" "이름 지정 규칙"과 "코드를 문서화"주장?

프로그래머는이 사실을 상기시켜 주며, 특히 문서화하고 있습니다. 그러나 다른 한편으로, 이것들은 많은면에서 정말로 필수적입니다.

Answer 1

내가 얼마나 ...

많이해야한다.

너무 많음,하지만 충분합니다. 코딩 스타일과 명명 규칙은 프로그래머가 작성하는 코드의 품질에서 중요한 부분입니다. 내가 프로그래머를 고용했고,이 개 다음 코드 조각을 작성 한 후보가 있다면 :

하나 :

int main(int argc,char*argv[]){ 
int a=atoi(argv[1]); 
int b=atoi(argv[2]); 
printf("%d+%d=%d\n",a,b,a+b); 
return(0); 
} 

2 :

int main(int argc, char *argv[]) 
{ 
    int a = atoi(argv[1]); 
    int b = atoi(argv[2]); 
    printf("%d + %d = %d\n", a, b, a+b); 
    return 0; 
} 

내가 확실히 두 번째를 선택할 것.

설명서? 그것은 또한 매우 중요합니다. 코드는 올바르게 문서화되어야합니다. 즉, 문서는 깨끗하고 간결하며 훌륭한 영어를 사용하여 작성해야합니다 ("두 가지 매개 변수의 합을 계산하십시오"는 용납 할 수 없습니다!)하지만 너무 길지 않아야합니다. 좋은 코드를 읽을 수 있어야합니다. 자명하다.