English 中文(简体)
是否有任何基本标准和做法可读人类法典?
原标题:Are there any basic standards and practices for making human readable code?

更具体地说,使超文本、 Java和 p更容易读? 是否有人建议这种方案拟定的学生?

最佳回答
  1. 采用一致的排外和命名。

  2. 利用表格(如果有的方括号)提供视觉流。

  3. 利用评论解释在概念和技术上发生的情况。 (例如,我们是否有有效的用户?) 页: 1 核对用户 ID is not -1)

我确信,更多的季节性开发商会提出更多的建议,但这些建议是我最先提出的。

问题回答

适当拒绝和内容翔实的评论。

Use indentation, comments and coding conventions (for-eck PEP8

• 确保你的法典结构完善(适当的登革、空白线以分离成的代码等),并使用标准、一致和全称(而不是不可理解的缩略语)。

另一些建议采用适当的评论。 我倾向于不同意。 如果你的法典结构良好,变量名称也很好,那么评论只会掩盖事情。 规则的例外是,当你必须做一些反工作,在其他地方工作(我过去不得不在《世界合作框架》和《实体框架法》中援引这一点)。

请大家(或至少以你为首)宣读你的代码。

查阅这本书: Clean Code: a Handbook of agile 软件 craftsmanship. 所有这一切都涉及到使法典能够读懂。

一条建议不与姓名相呼应。 例如,如果你有一个 Java级,即实施变压器接口,并且将<代码>String改为Date,则不犹豫地指定<代码>。 String ToDate TransformerImpl.

你们总是能够使用“友好测试”。 • 向完全不了解节目制作的人展示你的代码。 如果他能够看到某种功能的多少,则该守则可能可以读懂。

在撰写超文本时进行适当迟缓,可能是一生,特别是当你与任何形式的nes子保持互动时。 这与诱惑是一致的,并确保在你搬走或删除一个荒唐的元素时更新周围线。 这使得更新该网页更加容易,因为登革热程度会使你在网页上的位置不使用某种Ctrl+Fmaneuver。

还值得注意的是,如果你与超文本一道重新使用特别安全局,适当的命名至关重要! 这将改进你的工作流程和你的法典的可读性。

在撰写“real”(Java、Av、C等)法典时,我也是一大fan的 in、间隔和评论。 我倾向于(x+1)而不是(x+1),因为我个人认为,这在可读性上有很大不同。 我把眼光放开,加之等,更方便地看着我。 符合你的勇敢/冷静风格和自由评论——记住,重写方法名称不是评论!





相关问题
Spring Properties File

Hi have this j2ee web application developed using spring framework. I have a problem with rendering mnessages in nihongo characters from the properties file. I tried converting the file to ascii using ...

Logging a global ID in multiple components

I have a system which contains multiple applications connected together using JMS and Spring Integration. Messages get sent along a chain of applications. [App A] -> [App B] -> [App C] We set a ...

Java Library Size

If I m given two Java Libraries in Jar format, 1 having no bells and whistles, and the other having lots of them that will mostly go unused.... my question is: How will the larger, mostly unused ...

How to get the Array Class for a given Class in Java?

I have a Class variable that holds a certain type and I need to get a variable that holds the corresponding array class. The best I could come up with is this: Class arrayOfFooClass = java.lang....

SQLite , Derby vs file system

I m working on a Java desktop application that reads and writes from/to different files. I think a better solution would be to replace the file system by a SQLite database. How hard is it to migrate ...

热门标签