是否有任何基本的标准和实践,使人类可读的代码?

1. 使用一致的大小写和命名。

2. 使用制表符(和括号,如果有的话)来提供一个可视化的流程。

适当的缩进和信息性的评论。

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

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

其他人则建议使用适当的评论。我倾向于不同意。如果您的代码结构良好,变量名称良好,那么注释只会把事情搞得一团糟。这个规则的例外是,当您必须做一些违反直觉的事情来解决其他地方的bug时(我过去不得不在WCF和实体框架代码中使用这个)。

试着大声读出你的代码(或者至少在你的脑子里)。

看看这本书: Clean Code: a handbook of agile software craftsmanship

有一条建议是不要在名字上偷懒。例如,如果您有一个Java类,它是Transformer接口的一个实现,并且它转换 String 到 Date ,毫不犹豫地说出班级的名字 StringToDateTransformerImpl .

嗯,你可以用“无知测试”。把你的代码展示给一个对编程一无所知的人。如果他或多或少能看到函数的功能,那么代码可能是可读的。

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

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