coding-style - 坚持“编码风格”、“命名约定”和“记录代码”

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);
}

二：

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;
}

我肯定会选择第二个。

文档？这也很重要。代码应该被正确记录——我的意思是，文档必须干净、简洁、用良好的英语编写（“diz funktion iz calculate teh sum of two params”是不可接受的！）但它也不应该太长——好的代码是可读的并且不言自明。