上图代码中,你觉得左边实现更好,还是右边的实现更好 ?你的代码是更像左边还是更接近右边?首先说下,这个例子不是很好,但是我觉得又挺好,因为这个例子不够极端,但是针对这样的case去阐述观点,可以更加明确;我的观点,也是本文接下去的观点,是倾向于右边,当然在这个例子中,可能大家会觉得右边的代码有点没有必要的复杂化了,左边的代码非常简洁明晰,这里说下观点背后的思考:
给函数和变量取个好名字是优秀程序员的基本功,取名的基本要求是 名副其实,见文知意。如果名称需要注释来补充,那就不算是个好名字。
机器可读的 JSON 模式提供一个机器可读的模式可以精确的指定你的 API。使用 prmd 来管理你的模式,并确保它能被prmd verify 验证。人类可读的文档提供人类可读的文档让客户端开发人员可以理解你的 API。如果你用 prmd 创建了一个概要并且按上述要求描述,你可以为所有节点很容易的使用prmd doc生成 Markdown文档。
关注时代Java