是否有制作人类可读代码的基本标准和实践?

时间:2010-09-28 12:43:21

标签: java python html human-readable

更具体地说,使HTML,Java和python更具可读性?有没有人对这个编程学生有什么建议?

9 个答案:

答案 0 :(得分:5)

确保您的代码结构良好(适当的缩进,用于分隔代码部分的空行等)并使用标准的,一致的和完全命名的(而不是难以理解的缩写)变量名称。

其他人会建议使用适当的评论。我倾向于不同意。如果你的代码结构合理,变量名称很好,那么评论会让事情变得混乱。规则的例外是当你必须做一些反直觉的事情来解决其他地方的错误时(我过去不得不在WCF和实体框架代码中使用它)。

答案 1 :(得分:5)

适当的缩进和内容丰富的评论。

答案 2 :(得分:5)

  1. 使用一致的套管和命名。

  2. 使用标签(和可用的括号)提供可视流程。

  3. 使用注释来解释在概念上和技术上发生的事情。 (例如,//我们是否有有效用户?不是//​​检查user_ID不是-1)

  4. 我相信一些经验丰富的开发者会有更多的建议,但那些是我的前3名。

答案 3 :(得分:5)

使用缩进,注释和编码约定(对于Python检查PEP8

答案 4 :(得分:3)

尝试大声读取您的代码(或至少在您脑海中)。

答案 5 :(得分:3)

看看这本书:Clean Code: a handbook of agile software craftsmanship。这完全是为了使代码可读和易懂。

答案 6 :(得分:2)

一条建议是不要懒惰的名字。例如,如果您有一个Java类,它是Transformer接口的一个实现,并且它将String转换为Date,请不要犹豫,将该类命名为StringToDateTransformerImpl

答案 7 :(得分:2)

好吧,你可以随时使用“无知测试”。将代码显示给对程序完全一无所知的人。如果他能够或多或少地看到函数的作用,那么代码可能是可读的。

答案 8 :(得分:1)

编写HTML时的正确缩进可以成为救星,尤其是当您与任何类型的嵌套元素进行交互时。只需与缩进保持一致,并确保在移动或删除缩进元素时更新周围的行。这使得更新页面变得更加容易,因为缩进级别将提供关于您在页面中的位置的线索,而无需采用某种Ctrl + F操作。

值得注意的是,如果您将CSS与HTML结合使用,正确的命名至关重要!它将改善您的工作流程和代码的可读性。

在编写“真实”(Java,Python,C等)代码时,我也是缩进,间距和注释的忠实粉丝。我倾向于(x + 1)超过(x + 1)因为我个人认为它在可读性上有很大的不同。我将演员阵容,增量等等分开,他们更容易吸引我的注意力。与您的括号/缩进样式保持一致,并自由评论 - 记住,重写方法名称不是评论!