写点什么

释放开发人员生产力:“文档级”代码了解一下?

  • 2023-09-08
    广东
  • 本文字数:3288 字

    阅读完需:约 11 分钟

网上一个经久不衰的段子:

程序员最讨厌的四件事:

1、 写注释

2、 写文档

3、 别人不写注释

4、 别人不写文档

今天我们就从让开发人员“看不惯又干不掉”的文档。


一、文档的重要性


高质量文档是记录和传达信息的有效工具,可以帮助人们理解和遵守规范、政策和程序。它们还可以作为参考和证据,以支持决策和解决问题。通过书面记录,人们可以更长时间地保存和共享知识。此外,良好的文档还可以提高工作效率,减少误解和错误。总之,文档在个人生活和工作中扮演着重要角色,并且对组织的可持续发展至关重要。


对于一个组织或团队来说,高质量的文档有许多益处。首先,文档可以使代码和 API 更容易被理解,减少错误发生的概率。其次,文档可以让团队成员更加专注于目标,迅速解决问题。此外,文档也使得一些手工操作更加轻松。另外,如果新成员加入,文档可以让他们更快地融入团队。


撰写文档具有严重的收益滞后性,与测试不同,运行一个测试用例可以立即告知正确与否,其价值立即体现。通过编写一份文档,随着时间的推移,它的重要性会逐渐显现出来。你可能只需写一次,但它将会被读取多次,频次可达数百次,甚至上千次。


一份出色的文档能够在未来代替你回答以下问题:•当时为什么做出这样的决策?•为何代码被这样实现?•到底有哪些概念被纳入这个项目中?•……撰写文档对于作者本身也有着巨大的益处:•协助您规范 API 设计:撰写文档是审视 API 的过程,通过编写文档可以使您思考 API 设计是否合理,是否全面。如果您无法用语言准确描述 API,那么说明当前的 API 设计是不合理的。•文档也是代码的另一种呈现方式:例如,如果你在两年后再次看到你曾经写过的代码,只要有注释和文档,你就能迅速理解代码。•提升代码的专业性:我们都会有这样的感觉,只要有完整文档的 API 都是设计良好的 API。尽管这个感觉并不完全正确,但两者确实密不可分,在很多人眼中,文档的完善程度也成为衡量一个产品专业性的指标。•防止无谓的重复问题打扰:一些问题可以直接记录在文档中,这样当有人来问你时,你可以让他们直接查看文档,而不必再重复解释一遍。。


二、为什么大多数人都不喜欢写文档


为什么很多人还没有养成写文档的习惯呢?毕竟问题经过长时间后,文档就变得非常重要了。除了之前提到的文档收益滞后的原因外,还有以下几个因素:


•许多工程师习惯将编写代码和写作分割开来,不仅仅是在工作中,而且在思维上认为它们是完全无关的两项任务,因此导致许多人更注重代码而忽视文档的重要性。


•许多工程师也认为自己不擅长写作,于是索性选择不写。然而,这只是一种偷懒的借口。其实,编写文档并不需要华丽的辞藻或者生动的语言,你只需要把问题讲清楚就好了。


•某些时候,工具不好用也会对文档撰写产生影响。如果没有一个优质的写作工具将文档写作融入开发工作流程中,写作的负担确实会增加。


•绝大多数人认为写文档是工作的另外一项负担。我已经没时间写代码了,更何况写文档!这其实是一个错误的观念。虽然编写文档可能需要一些前期投入,但它能大大降低代码维护的后期成本。相信大家都能理解磨刀不误砍柴工这个道理。


三、AI 工具来帮忙


如果说现在有一个 AI 编程工具,可以生成“文档级”的代码,是不是可以解决绝大多数不会写、不想写注释、文档的开发人员的大问题?


FuncGPT(慧函数) AI 生成器作为飞算 SoFlu 软件机器人的一个重要组成部分,支持所有类型函数创建。慧函数(FuncGPT )AI 生成器通过自然语言描述 Java 函数需求,实时生成高质量、高可读性的 Java 函数代码。生成代码可直接复制到 IDEA,或一键导入 Java 全自动开发工具函数库。


FuncGPT(慧函数)可以很好的解决以下代码问题:1、代码规范:生成符合 Java 语法和代码规范的函数代码,生成的代码将更易于阅读和理解。2、代码复用:生成的函数代码会倾向于使用可复用的最佳实践。可以减少冗余代码,提高代码的可维护性。3、代码注释:生成的代码会包含清晰的代码注释,帮助开发工程师理解函数的用途和输入输出。良好的注释对于后期维护非常重要。4、代码结构:生成的代码会倾向于使用良好的代码结构,避免过长的函数和过度嵌套。这有助于提高代码的可读性和可维护性。5、大量减少代码调试工作:生成的代码经过大规模联合训练,它能够生成较为准确和稳定的代码,从而减少了由于代码错误引起的调试工作。


以任务管理系统中使用 Java 函数实现计算任务剩余时间的功能为例。

函数功能:计算两个日期相差天数(返回字符串);

参数 1:参数名称:startTime;参数类型:Date;参数描述:开始时间

参数 2:参数名称:endTime;参数类型:Date;参数描述:结束时间

参数 3:参数名称:format;参数类型:String;参数描述:格式化字符,例:天,时,分


// 类名:DateUtils// 函数名:calculateDateDifference// 函数功能:计算两个日期相差天数// POM依赖包:// <dependency>//     <groupId>joda-time</groupId>//     <artifactId>joda-time</artifactId>//     <version>2.10.10</version>// </dependency>
import org.joda.time.DateTime;import org.joda.time.Days;
public class DateUtils { /** * 计算两个日期相差天数 * @param startTime 开始时间 * @param endTime 结束时间 * @return 相差天数字符串 */ public static String calculateDateDifference(DateTime startTime, DateTime endTime, String format) { Days days = Days.daysBetween(startTime, endTime); // 使用Joda-Time计算相差天数 int difference = days.getDays();
String result; switch (format) { case "天": result = difference + "天"; break; case "时": result = difference * 24 + "小时"; break; case "分": result = difference * 24 * 60 + "分钟"; break; default: throw new IllegalArgumentException("Invalid format"); // 如果格式不合法,抛出异常 }
return result; }}
// 函数示例// 计算两个日期相差天数示例// 入参:startTime,开始时间,类型为DateTime;endTime,结束时间,类型为DateTime;format,格式化字符,类型为String// 出参:result,相差天数字符串// 调用示例:// DateTime startTime = new DateTime(2022, 1, 1, 0, 0); // 创建开始时间对象// DateTime endTime = new DateTime(2022, 1, 5, 0, 0); // 创建结束时间对象// String result = DateUtils.calculateDateDifference(startTime, endTime, "天");// System.out.println(result);// 输出结果:例如,计算2022年1月1日和2022年1月5日相差天数为:4// 则输出结果为:4天
复制代码


通过分析不难发现:

1、注解:代码上方有一段 XML 注解,表明该类需要 joda-time 库版本 2.10.10。这对于理解代码的依赖关系和运行环境非常重要。

2、可读性:函数名的命名是清晰和描述性的,它表明了这个函数的主要功能。参数名也是明确的,可以很容易地理解每个参数的作用。每个代码块(如导入语句和函数体)都使用合适的缩进和空格,使得代码易于阅读。

3、代码质量:

 使用 Days.daysBetween 方法计算两个日期之间的天数差异,这是一个很好的做法,因为它避免了直接进行时间差计算可能产生的问题(例如夏令时、时区等)。

 使用了 switch-case 结构对不同的格式请求进行了处理,这样可以灵活地满足不同的需求。对于无效的格式输入,方法抛出了一个 IllegalArgumentException,这表明了对于异常情况的处理。

 使用了合理的变量名和方法名,使得代码易于理解和维护。

 使用了合理的注释,解释了代码的功能和参数的作用。

 代码中没有使用任何魔法数或硬编码的值,而是使用了适当的常量或变量。

 输入参数类型为 DateTime,这使得函数具有很好的通用性,可以接受各种时间格式。

 返回类型为 String,这使得函数的输出具有良好的可读性和可展示性。如果你也想体验 FuncGPT(慧函数)带来的高效高质量的开发体验,免费下载使用吧:https://c.suo.nz/7Pqq3

用户头像

飞算云智官方账号 2021-08-10 加入

想了解更多产品内容,欢迎关注微信公众号:飞算SoFlu软件机器人 免费试用申请:http://feisuanyz.mikecrm.com/9dW4GeZ

评论

发布
暂无评论
释放开发人员生产力:“文档级”代码了解一下?_代码质量_SoFlu软件机器人_InfoQ写作社区