程序设计中的技术文档是什么,干什么用,怎么用,希望能给个详细的解答

程序设计中的技术文档是什么,干什么用,怎么用,希望能给个详细的解答,第1张

技术文档可以是帮助,也可以是教程,也可以是开发者的心得体会等等。

微软和adobe的技术文档都是教程外加小部分的bug列表以及解决方法。

明白这些就简单了,你可以把它做成chm或者pdf再干脆点就是txt文本,看你的爱好了。

文档是指用来描述程序的内容、组成、设计、功能规格、开发情况、测试结果及使用方法的文字资料和图表等,如程序设计说明书、流程图、用户手册等。

编程开发时将必要说明加入所写代码,完成后生成文档并做必要修改。

我觉得是的。

平时写技术文档时,基本都是用的markdown,代码块、流程图、序列图、甘特图、列表等应有尽有。非常方便程序员书写。

建议答主学会这个程序员必备的文档编辑技能,便于在日常的工作中提高沟通的效率,平时也可以用markdown,在github上提交自己的项目描述readme和搭建自己的博客。

1.斜体和粗体

使用*和**表示斜体和粗体。

示例:

这是*斜体*,这是**粗体**。

2.标题

使用#加空格表示一级标题,同理,##加空格表示二级标题

#一级标题

##二级标题

###三级标题

####四级标题

#####五级标题

######六级标题

3.外链接

使用[描述](链接地址)为文字增加外链接。

示例:

这是去往[我的博客](`。

8.代码块

使用四个缩进空格或```表示代码块。

示例:

```这是一个代码块,此行左侧有四个不可见的空格。```

9.插入图像

![image](图片链接)

10.插入音乐

**插入单曲**在网易云音乐里找生成外连接,复制过来就OK了,可惜的是很多都不能生成外联连接。如果不想自动播放,可以把auto改成1[这一生关于你的风景]


欢迎分享,转载请注明来源:内存溢出

原文地址:https://54852.com/yw/11300030.html

(0)
打赏 微信扫一扫微信扫一扫 支付宝扫一扫支付宝扫一扫
上一篇 2023-05-15
下一篇2023-05-15

发表评论

登录后才能评论

评论列表(0条)

    保存