是否有制作人类可读代码的基本标准和实践?
-
26-09-2019 - |
题
更具体地说,是让 HTML、Java 和 python 更具可读性?有人对这个编程学生有建议吗?
解决方案
使用一致的大小写和命名。
使用选项卡(和括号(如果有))提供视觉流程。
使用注释来解释概念上和技术上发生的事情。(例如,//我们有有效的用户吗?not //检查user_ID是否不为-1)
我确信一些经验丰富的开发人员会提出更多建议,但这些是我的前 3 个建议。
其他提示
适当的缩进和信息注释。
使用压痕,评论和编码约定(对于Python检查 PEP8 )
请确保您的代码结构良好(正确的缩进,空行的代码等独立的部分),并使用标准的,一致的,充分命名(而不是难以理解的缩写)的变量名。
其他建议使用适当的意见。我倾向于不同意。如果你的代码是良好的结构和变量以及命名,然后评论只会添乱的东西了。该例外是当你必须做一些反直觉来解决一个bug其他地方(我不得不求助于此在WCF和实体框架的代码在过去的)。
尝试朗读代码出(或在头部至少)。
看一看这本书:清洁代码:敏捷软件工艺的手册。它是关于使代码阅读和理解所有
建议的一个片是不是要懒惰与名称。举例来说,如果你有一个Java类,这是变压器接口的实现,并将其转换String
到Date
,不要犹豫,命名类StringToDateTransformerImpl
。
好了,你可以随时使用“无知的考验。”显示你的代码的人谁绝对一无所知programmation。如果他能看到更多或更少的功能是什么,代码可能是可读的。
正确的压痕时写HTML可以挽救人的生命,尤其是当你与任何类型的嵌套元素的交互。只要是与缩进一致,并确保当您移动或删除缩进元更新对周边线路。这使得它更容易更新的页面,如压痕水平将给出一个线索,你在页面不诉诸某种按Ctrl + F演习的地方。
另外值得一提的是,如果你在与HTML结合使用CSS,正确命名是关键!它会提高你的工作流程和代码的可读性。
我也缩进,间距和评论的忠实粉丝写的“真实”(使用Java,Python,C等)的代码时。我对(X + 1)俯身(X + 1),因为我个人认为它使可读性有很大的区别。出管型,增量,等我的空间,他们抓住我的眼睛更容易。与您的支架/缩进风格保持一致,并评论从优! - 请记住,重新写一个方法名是不是注释