码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift
  • A Philosophy of Software Design读书笔记——设计两次&写注释


    设计两次

    软件设计很困难,很难第一次就设计出正确的接口。每个设计2次,通常能够发现第一次设计中的缺点。

    设计两次通常不会花很多时间,与实现相比,这部分时间占比很小(设计2次很简单,但是有时候只有在实现时才能意识到之前设计的缺陷,从这个角度看过去,设计两次的代价就很大了),反而有时间一开始并不清楚代码怎么写,先着手写,等实现了部分功能之后,这时可以重新审视下设计,甚至重新写之前的代码,效果会更好。

    注释

    注释为了帮助使用者更好的理解和使用模块,但注释的作用不止于此,能够更好的记录设计思路,甚至改进设计。但是很多人不写注释,原因如下:

    1、好的代码本身就是注释

    2、没时间写注释

    3、注释会过时,从而给用户误导

    4、我看到的注释都没有太多的价值

    作者从这4个角度分别反驳这4个观点:

    1、好的代码本身就是注释:如果使用者必须通过阅读代码细节来了解接口的使用,那么这个接口抽象的不好

    2、没时间写注释:写注释不会超过软件开发时间的10%

    3、注释会过时,从而给用户误导:文档和注释要跟着代码的演进而演进

    注释文档的好处:

    能够从注释中捕捉到代码后面的设计思想,第二章中指出的增加复杂性的三个点:更改放大、认知负担、不知道自己不知道,这三点都可以通过注释一定程度上改善。

  • 相关阅读:
    03目标检测-传统方法与深度学习算法对比
    Mysql和ES、Redis数据同步方案汇总
    43、Spring AMQP TopicExchange
    Python-print骚操作之rich库
    Java注解详解和自定义注解实战,用代码讲解
    【虚拟仿真】Unity3D中实现3DUI,并且实现Button、InputField、Toggle等事件绑定
    【SpringBoot实战】核心配置和注解
    Unity Quaternion接口API的常用方法解析_unity基础开发教程
    nodeJs--url模块
    Day20 | 每天五道题
  • 原文地址:https://blog.csdn.net/yh88623131/article/details/128065420
  • 最新文章
  • 沪漂五周年了:我越来越迷茫了
    Agentic Skill Routing 实战:别再把所有 Skill 塞进 AI Agent 上下文
    MySQL-Seconds_behind_master的精度误差
    [MAF预定义ChatClient中间件-03]CachingChatClient——利用缓存省钱省时间
    AI的至暗历史:从万众期待到被政府撤资,AI的两次死亡徘徊
    Agent OS :五种驯服不确定性的范式
    PortSwigger SQL注入LAB11
    数据库即时编译JIT
    [Begin]AI Learn Data Day 0
    深度学习进阶(二十七)现代 LLM 的核心架构设计其二:SwiGLU
  • 热门文章
  • 十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧!!!
    奉劝各位学弟学妹们,该打造你的技术影响力了!
    五年了,我在 CSDN 的两个一百万。
    Java俄罗斯方块,老程序员花了一个周末,连接中学年代!
    面试官都震惊,你这网络基础可以啊!
    你真的会用百度吗?我不信 — 那些不为人知的搜索引擎语法
    心情不好的时候,用 Python 画棵樱花树送给自己吧
    通宵一晚做出来的一款类似CS的第一人称射击游戏Demo!原来做游戏也不是很难,连憨憨学妹都学会了!
    13 万字 C 语言从入门到精通保姆级教程2021 年版
    10行代码集2000张美女图,Python爬虫120例,再上征途
小工具 小游戏
Copyright © 2022 侵权请联系2656653265@qq.com    京ICP备2022015340号-1

京公网安备 11010502049817号