写代码跟写文档哪个感觉好？

最新推荐文章于 2024-03-13 17:07:13 发布
原创 最新推荐文章于 2024-03-13 17:07:13 发布 · 452 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

对于程序员而言，编写代码如同每日三餐，不可或缺。然而，技术文档的撰写同样是项目中重要的一环。本文探讨了代码编写与技术文档撰写之间的区别与联系，分析两者在软件开发过程中的作用。

写代码对于程序员来说

就像每天都要吃饭一样

但是难免需要写一些技术文档

写代码和写技术文档、

你觉得那个比较好？

xiaoyaGrace
关注
FPGA经验谈系列文章——2、写代码心中要有电路?
gzy0506的博客
11-23 6818
提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 FPGA经验谈系列文章——写代码心中要有电路?前言心中无需电路的情况心中有电路的情况总结 前言 很早很早以前，我就从无数个帖子中看到一些这样的论述。例如“verilog是一个硬件描述语言，写代码的时候心中要知道其对应的电路是什么”，工作的前面几年，我完全不理解为什么会有这样的论述，我verilog代码写的好好的，功能也能实现，根本不需要在意什么电路之类的。工作久了之后，慢慢才发现这句话还是有一定的道理，慢慢有一点领悟了吧。 心中无需电路的
写代码犹如写文章: “大师级程序员把系统当故事来讲，而不是当做程序来写” | 如何架构设计复杂业务系统? 如何写复杂业务代码？
AI天才研究院
08-20 9970
写代码犹如写文章: “大师级程序员把系统当故事来讲，而不是当做程序来写” | 如何架构设计复杂业务系统? 如何写复杂业务代码？ Kotlin 开发者社区 “大师级程序员把系统当故事来讲，而不是当做程序来写” 写代码犹如写文章 好的代码应该如好文章一样表达思想，被人读懂。 中心思想: 突出明确 程序是开发者用编程语言写成的一本书，首...
程序员既要写好代码，又要写好文档
SimonXiaoZhou的专栏
10-19 2922
转自：http://www.daxixiong.com/?/article/7 作为一个长期混迹于优快云社区的人，我对很多拥有高访问量的博主钦佩不已，特别是在参加了优快云在举办“2014 优快云博文大赛”及“2015 优快云-Markdown博文大赛”活动之后。我看到活动中的一些参赛作品条理清晰、文笔流畅、语言优美，大都出自程序员之手。我不禁想到一个问题：程序员是否应该注重文档的编写？
写项目文档比写代码难多了
weixin_34037173的博客
05-04 280
写项目文档比写程序代码难好多，也有异曲同工之处。首先思路要清晰，结构也要清晰。然后就是措辞，最后就是文档格式。额好难，明天继续写。 转载于:https://blog.51cto.com/3006532/1641890...
咸鱼的思考1--如何看待写代码与写文档
alvinzxf的博客
02-05 278
问题 新人接手项目时，最怕的就是啥说明都没有，只有代码的项目，运气好的还有人短期指导你一阵，运气差的怕是上来就接手一堆代码，组里也没有人熟悉，这个时候就只能看代码 观点 写文档就是浪费时间 没有文档就是瞎搞 究竟要不要写文档呢？相信各位觉得文档还是必要的，尽管写文档确实很花时间 哪些文档 文档也不是越多越好，文档是为了让开发更快地熟悉项目，但过多的文档，则看不到重点了。结合本人经历的项目列举以...
有人说：写代码的比不上会写PPT的？其实你应该换个角度来看！
PS学习社
04-04 626
在互联网行业有这样的一种说法：写代码的不如讲PPT的，这些讲PPT在实际的工作中好像并没有发挥出太大的价值，而凭借着PPT做的比较好，讲解比较清晰流畅，更容易获得晋升和老板的赏识。很多做技术岗位的人就感到不公，我在产品开发过程中做了很大的工作量，为什么在升职加薪上不如一个讲PPT的。对于讲PPT的就没有什么真本事也不是绝对的，很多时候PPT的讲解也是一项非常重要的技能。 再好的产品，别人看不懂，...
（八）写文档的一些感想
Mr.赵的专栏
09-08 704
代码的工作完成以后感觉博客要写什么实在不好把握，最近都在写文档，那么我就说说写文档的一些感受吧
精选资源
AndroidCodeStandard:Android代码规范文档
03-05
你的代码写得比较规范，，但是迟迟没有出一个代码规范，说来惭愧，只是因为我早几年写的代码还不够规范，不敢出来误导大家，而代码规范是后续才慢慢养成的，在这个过程中，我另外参考了大公司出的代码规范文档，...
系统设计（二）如何写技术设计文档
不忘初心的专栏
12-19 1万+
如何写一份优秀的系统设计文档？ 作为一名架构师，系统技术方案设计文档应该是必备技能，一份优秀的设计文档应该包含：业务分析、系统架构设计、数据分析、风险防控和非功能性设计等几个大方面‘。
程序员是否该写文档？
Eden's space
01-16 4129
不论是需求的原型，测试使用的TestCase，离职时候的交接文档，个人的学习笔记，或者是怕忘记做的备忘录，这些都算是文档，你有写文档的习惯吗？ 甲：要求写的时候写，不要求写的时候懒得写 乙：有时候记点儿东西，脑子记不住，一般用有道云笔记记录一下 丙：有，离职的时候这些，必须要求写的 …… 如果你写过文档，或者有写文档的习惯，你上一次写是什么时候？距离现在有多长时间了？ 甲：刚刚才写
软工总结——写文档真的重要吗？
不忘初心，方得始终
12-21 1863
今天晚上师傅给我验收软工文档，提到软工文档很重要，确实自己写的也不怎么样，毕竟第一次写都是照着模板和别人思维成品，一点一点磨出来的。有时候不会写了甚至从别人的博客上复制下来一段，写文档这个过程真的很难受，可能是理科生的原因，看见文档就犯怵。不知道大家有没有同感，宁可再看一遍视频也不想去写文档。当然了，有的人可能觉得文档有什么好写的，瞎写写得了。所以这个阶段过的很快，快点的两三天，慢一点的大概也就一
Day01程序员既要写好代码，又要写好文档(1)
翁老师的教学团队
09-08 450
文档编写能力 程序员既要写好代码，又要写好文档 “代码”和“文档”就像是一个人的左膀右臂，一定要让两者均衡发展，而不能够只顾其一 (1)任责要求 (2)研发文档，这些文档包括：详细设计文档、单元/集成测试文档、软件版本开发报告、软件安装说明、软件升级指导书等 (3)简历中提供csdn等博客账号 Snipaste Snipaste是一个简单但强大的截图工具 解压 大量的文档编写中需要使用到截图 设置快捷键 Xmind Xmind是什么？ XMind 是一款非常实用的商业思维导图软件 Xmind有什么特
【lizhi125】帮你揪出文档/代码的差异 文档内容差异对比工具-WinMerge中文版
lizhi125的专栏
08-20 1257
经常写文档或者写程序代码的朋友肯定经常会遇到相似的文档需要比较一下它们的差异。例如在程序代码升级、备份或修改后，想知道新代码与旧代码到底有哪些地方不同；或者你写了几分文稿，反反复复地修改过好几次，你想找回他们具体的差异，但这时想要用肉眼去对比，一行一行地查看无异于逼自己的脑细胞去自杀。其实，我们大可以利用一些专业的对比软件，比如Beyond Compare；但BC是一款商业软件，需要购买。而今天l
代码即文档(Martin Fowler )
Coding Free
10-07 1632
敏捷软件开发的一个常见的做法，就是将程序编写提升到软件开发的核心角色，这比很多软件开发通常的做法要重要的多。这部分是将代码归类为软件系统的主要文档（如果不是主要文档）。 我感觉需要立即反驳一个普遍的误解，即代码是唯一的文档，尽管我经听到极限编程的这个说法 — 我从来没有听到极限编程的领导人这么说。通常还是需要进一步的文档来作为代码的补充。 把代码作为主要的文档...
【十万个编程篇】写文章与“写项目”的差别
大昱的博客
03-21 1297
  自古暨今，世间陆续诞生出“现象级”的文学作品，如《左传》、《桃花源记》、《背影》等文章，又如《咏鹅》、《将进酒》、《一剪梅》等诗词。   编程世界也同样续写着新的辉煌，如Unix、Windows、Linux等内核系统，又如Apache、Tengine、ECharts等开源项目。   它们无一例外，都标志着历史的发展与演变过程。它们也拥有着独特的风格，只有“现...
谈写脚本、写代码和编程三者的区别
热门推荐
developer_biao的专栏
06-07 3万+
此为译文，原文地址：http://www.naelshawwa.com/scripting-coding-programming/ @Laurenonizzle 发了一条链接到一个论坛的推特，讨论写脚本，写代码，编程三者之间的区别。我把我的一些关于此问题的看法写在这里，不当之处欢迎批评指正。 就像一些人在论坛指出的那样，三者之间的区别有时比较模糊，因为这三种说法有时候可以互相转换。
Java使用文本编写源代码
weixin_47962244的博客
03-08 4041
第一步：在文本编写源代码 public class Test{ public static void main(String[] args){ System.out.println("Hellow Java"); } } 第二步：打开控制器cmd，输入java -version。出现下面的信息说明本地已经配置好Java，不然要先去配置 C:\Users\Administrator>java -version java version "1.8.0_131" Java
代码即文档？
sigmarising的博客
03-13 726
为什么我们经常接手的都是无文档无注释的 shit mountain code 项目呢？首先绝大多数程序员连注释都懒得写（例如函数签名注释都懒得写），你更别要求他能给你留下文档了。，而往往极其难以有人（团队）能真正的做到以上这些的。”一定是一种极其理想的状态。又一个“理想和现实”
使用vs code写量化代码，越基础越好
最新发布
02-27
好的，我现在需要帮用户介绍如何使用VS Code编写量化代码，越基础越好。首先，我得确定用户可能对哪些方面不熟悉。可能包括安装配置、基本功能、常用库、简单策略示例，以及调试和回测这些环节。 用户是刚入门的，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值