代码即文档?

又一个“理想和现实”

可以肯定的是,“代码即文档”一定是一种极其理想的状态。

当我们假定前提为:

`Code is doc` > `Code + comments``Code + docs` > `Code`

我们可以发现,真正的“代码即文档”的践行,是对于编程能力(项目结构、命名及语义风格、设计模式、合作严格审阅、易读性、高效性、简洁性)有着非常高的要求和挑战的,而往往极其难以有人(团队)能真正的做到以上这些的。

为什么我们经常接手的都是无文档无注释的 shit mountain code 项目呢?首先绝大多数程序员连注释都懒得写(例如函数签名注释都懒得写),你更别要求他能给你留下文档了。而更为重要的一点可能则在于:你的编程能力越强,代码即文档践行的越优秀,在现实高压社会环境下,你被新鲜出炉的年轻人代替的概率也会极大提高的(笑)。

最近更新

  1. docker php8.1+nginx base 镜像 dockerfile 配置

    2024-03-14 15:28:05       94 阅读
  2. Could not load dynamic library ‘cudart64_100.dll‘

    2024-03-14 15:28:05       100 阅读
  3. 在Django里面运行非项目文件

    2024-03-14 15:28:05       82 阅读
  4. Python语言-面向对象

    2024-03-14 15:28:05       91 阅读

热门阅读

  1. 前端面试 ===> 【ES6】

    2024-03-14 15:28:05       31 阅读
  2. 突破编程_C++_设计模式(备忘录模式)

    2024-03-14 15:28:05       35 阅读
  3. 大带宽服务器租用 满足高速网络访问

    2024-03-14 15:28:05       40 阅读
  4. 服务器镜像是什么

    2024-03-14 15:28:05       43 阅读
  5. proxy和Object.defineProperty

    2024-03-14 15:28:05       42 阅读
  6. Linux 用户和用户组管理

    2024-03-14 15:28:05       35 阅读
  7. ubuntu22.04环境中安装pylint

    2024-03-14 15:28:05       35 阅读
  8. 高通qcm2290功耗问题

    2024-03-14 15:28:05       36 阅读
  9. 数据类型(面向对象)

    2024-03-14 15:28:05       28 阅读
  10. YOLOv8模型验证以及一些报错

    2024-03-14 15:28:05       43 阅读
  11. 代码随想录day39:动态规划part7,完全背包继续

    2024-03-14 15:28:05       37 阅读
  12. django根据时间(年月日)动态修改表名--方法二

    2024-03-14 15:28:05       40 阅读
  13. ES6 Nunber类型、Math对象扩展

    2024-03-14 15:28:05       37 阅读
  14. IOS面试题object-c 81-90

    2024-03-14 15:28:05       42 阅读