更具体地说，使 HTML、Java 和 python 更具可读性？有人对这个编程学生有建议吗？
问问题
400 次
9 回答
5
确保您的代码结构良好（适当的缩进、分隔代码部分的空行等）并使用标准、一致且完全命名（而不是难以理解的缩写）变量名称。
其他人会建议使用适当的评论。我倾向于不同意。如果您的代码结构良好且变量命名良好，那么注释只会使事情变得混乱。规则的例外是当你必须做一些违反直觉的事情来解决其他地方的错误时（过去我不得不在 WCF 和实体框架代码中求助于这个）。
于 2010-09-28T12:46:39.907 回答
5
适当的缩进和信息丰富的评论。
于 2010-09-28T12:47:00.437 回答
5
使用一致的大小写和命名。
使用选项卡（和可用的括号）来提供视觉流程。
使用从概念上和技术上解释正在发生的事情的注释。（例如，//我们有一个有效的用户吗？不是 //检查 user_ID 不是 -1）
我相信一些更有经验的开发者会有更多的建议，但这些是我的前 3 名。
于 2010-09-28T12:47:54.960 回答
5
使用缩进、注释和编码约定（对于 Python 检查PEP8）
于 2010-09-28T12:47:59.700 回答
3
尝试大声朗读您的代码（或至少在您的脑海中）。
于 2010-09-28T12:50:09.150 回答
3
看看这本书：清洁代码：敏捷软件工艺手册。这一切都是为了使代码具有可读性和可理解性。
于 2010-09-28T12:50:45.077 回答
2
一条建议是不要对名字偷懒。例如，如果您有一个 Java 类，它是 Transformer 接口的实现，并且它转换String为Date，请不要犹豫，将类命名为StringToDateTransformerImpl。
于 2010-09-28T12:49:03.130 回答
2
好吧，您总是可以使用“无知测试”。向对编程一无所知的人展示您的代码。如果他可以或多或少地看到一个函数的作用，那么代码可能是可读的。
于 2010-09-28T12:54:30.697 回答
1
编写 HTML 时适当的缩进可以成为救命稻草，尤其是当您与任何类型的嵌套元素交互时。只需与缩进保持一致，并确保在移动或删除缩进元素时更新周围的线条。这使得更新页面变得更加容易，因为缩进级别将提供关于您在页面中的位置的线索，而无需诉诸某种 Ctrl+F 操作。
还值得注意的是，如果您将 CSS 与 HTML 结合使用，正确的命名至关重要！它将改善您的工作流程和代码的可读性。
在编写“真实”（Java、Python、C 等）代码时，我也非常喜欢缩进、间距和注释。我倾向于（x + 1）而不是（x + 1），因为我个人认为它对可读性有很大影响。我隔开演员表、增量等，它们更容易吸引我的眼球。与您的括号/缩进样式保持一致，并自由地注释 - 请记住，重写方法名称不是注释！
于 2010-09-28T13:47:30.113 回答