活文档总结

我们可以先看看日常开发中会涉及到哪些文档： 需求文档 接口文档 业务词汇表文档 模块业务流程文档 系统间交互文档 系统架构文档 系统依赖文档 发布文档 示例文档(tutorial) 项目进度文档 案例文档 汇报文档 要写的类型文档还是不少的，无论哪种文档，都与项目的代码是脱节的。 所以软件行业以往的文档编写方式有很多缺点： 文档易过时，因为与代码是分开的，改了代码忘改文档是很正常的，代码是新版本，而文档是历史版本 文档误导人，因为前一条，功能上的修改没有反映到文档上，读文档的人会被错误信息所误导 既然代码和文档分开使得两者不易统一，那么我们就去追求把代码与文档写在一起，并通过技术手段把文档从代码中生成出来。 ? 稳定文档 稳定文档指的是那些基本不怎么变动的文档，这种文档和代码分开是可以接受的，为了使我们的文档稳定，应该遵循一些基本的编写原则，比如： 不要带公司的那些容易变化的信息：公司名，子公司，品牌，商标等等

软件文档总结

在软件开发之前，有一项非常重要的工作，就是写软件文档，软件文档从形式上看的话，大致分为两类：一类是工作表格，就是开发过程中填写的各种表格；第二类就是编制的技术资料或者管理技术资料。 要是从文档的生产和使用范围来分则分为三类： ? 写好软件文档，一份好的文档相当于一份精美的介绍或者使用手册，让相关的工作人员充分的了解新的软件，从而做出更好地软件。

AI应用实战课学习总结（9）Hello 深度学习

最近入坑黄佳老师的《AI应用实战课》，记录下我的学习之旅，也算是总结回顾。 今天是我们的第9站，一起了解下大数据和GPU时代下的 深度学习 和 PyTorch框架。 它由 Facebook 的 AI 研究团队开发，并以 Python 编程语言为基础，提供了强大的 GPU 加速支持。

软件文档总结（二）

=    在软件文档中有几个比较重要的文档重点介绍一下    1、软件需求说明书    软件需求主要是从从现实中分离功能，描述软件要“做什么”，在软件需求说明书中，主要的功能和联系如下： ?     概要设计文档最重要的部分是分层数据流图、结构图、数据字典以及相应的文字说明等；详细设计文档最重要的部分是模块的流程图、状态图、局部变量及相应的文字说明等。一个模块一篇详细设计文档。 对于新用户来说基本操作手册是非常重要的，这也是很重要的文档。

mongoose官方文档总结

如果想更新单独一条文档并且返回给应用层，可以使用 findOneAndUpdate 方法。 六、文档-Documents Mongoose document代表着MongoDB文档的一对一映射。 -SubDocuments 子文档是指嵌套在另一个文档中的文档。 Mongoose子文档有两种不同的概念：子文档数组和单个嵌套子文档 const chidlSchema = new Schema({name:String}) const parentSchema = new Schema({ children:[childSchema], child:childSchema }) 子文档与文档的区别是 子文档不能单独保存，他们会在他们的顶级文档保存时保存 find() 是文档列表 count() 是文档数量 update() 是更新的文档数量 九 中间件–Middleware 中间件(pre 和 post 钩子)是在异步函数执行时函数传入的控制函数

开发工具总结（9）之开源项目的README文档的最全最规范写法

而那些使用量大的库的文档写的很标准，很详细，看的很舒服。 README文档写的好的话能减少很多使用成本，能帮助这个库让更多人了解，更多的人用，可以说好的文档就是一个门面。 有好的 README 文档的项目不一定是一个好开源项目，但一个好开源项目一定有一个好的 README。 下面就简单的总结一下README文档规范写法。 （这只是我个人根据github上几百个大型开源库总结出来的，如你有更好的意见，欢迎留言。） ? 一、README文档的组成部分 看过很多开源框架的README文档，综合一下，大概有以下几部分组成： （一）国际化 （二）项目工程介绍 （三）项目的使用效果图 （四）项目特点 （五）项目的基本结构（ 这里就拿 Glide 举例说明，Glide里面有一个详细的wiki使用文档的，首页的README里面也写了一个简单的基本用法，如下图所示： ?

Xcode文档注释使用总结

Xcode作为iOS的开发神器，为我们提供了十分丰富的文档提示功能，在开发过程中，我们可以十分方便的按下Option键，选中一个类或者方法查看其文档说明。 本篇主要介绍几种常用的文档注释方法。 多行注释文档 /** 多行注释文档相比于普通多行注释多了一个星号。 这里写图片描述 我们发现一个问题，效果图中前两行并没有换行，我们若是希望换行就需要在之间添加一个空行 ---- 单行注释文档 ///# 标题1 ///## 标题2 ///hello oc，下面的空行是为了换行 这里写图片描述 ---- 算法注释 算法是相对比较复杂的方法，我们通过注释对其进行详尽的说明，其文档注释使用的关键字如下： /// - Precondition: 前置条件 /// -

Vue.Draggable 文档总结

本文章转自https://blog.csdn.net/zjiang1994/article/details/79809687 Vue.Draggable学习总结 Draggable为基于Sortable.js

pdf转word文档总结

今天帮忙进行pdf转word，折腾半天，最终终于搞定了 这里介绍的方法分为两种，一种是直接转为图片版的word，也就是不可编辑的；另一种就是转为可编辑的word，目前很多软件都是要收费的~ 不可编辑的word文档 上传需要处理的文档后，设定分割方式，或者需要进行格式转换的页面范围，就可以在线处理，之后等待片刻把处理后的文档download就可以了~ https://www.pdftoword.com/ 这个网址也可以进行 有兴趣也可以看看源代码～ 可编辑的word文档的转换。这个找了很久才找到可用的。可以下载此处给出的软件，里边有注册机，可以用于破解软件。 窗口复制机器码到图3所示窗口，点击计算注册码，复制注册码，然后拷贝到图2所示的注册码位置，点击激活就OK啦~ 现在就可以点击读取，打开你想要转换的PDF，点击识别，识别完毕后点击word就自动可以保存到一个word文档中

pytest文档9-参数化parametrize

[ ("3+5", 8), ("2+4", 6), ("6 * 9" ========== FAILURES =================================== _____________________________ test_eval[6 * 9- 42] _____________________________ test_input = '6 * 9', expected = 42 @pytest.mark.parametrize( eval(test_input) == expected E AssertionError: assert 54 == 42 E + where 54 = eval('6 * 9' ("3+5", 8), ("2+4", 6), pytest.param("6 * 9"

Android 动画总结(9) - 过渡动画

前面已经介绍过一部分 Activity 之间的过渡动画。现在讲的不是 Activity 转场，而是同一个页面的 View 之间的过渡。

精通Java事务编程(9)-总结

事务作为抽象层，允许应用忽略DB 内部一些复杂并发问题和某些硬件、软件故障，简化应用层的处理逻辑：事务中止（transaction abort），而应用仅需重试。对复杂访问模式，事务可大大减少需要考虑的潜在错误情景数量。

9. 注解开发总结

PHP中9大缓存技术总结

max_input_time = 600 ; 每个PHP页面接收数据所需的最大时间，默认60 memory_limit = 128M ; 每个PHP页面所吃掉的最大内存，默认8M 9、

微信iOS9适配总结

每年iOS升级，都会带来一些坑，这次iOS9也不例外。本文总结了微信在适配iOS9上遇到的问题和解决方案。 一、iOS9问题汇总 1. 这是因为iOS9默认不支持HTTP请求，需要改用更安全的HTTPS（默认用TLS 1.2）。 6、API更新 iOS9照例淘汰了一些旧接口，其中有一些旧接口虽然还能用，但或多或少都会有些问题： 6.1 AddressBookUI.framework在iOS9上已经被淘汰，需要改用 用Xcode7 iOS9 SDK编译 b. 用Launch StoryBoard做启动界面 c. 三、总结 本文总结了微信在适配iOS9中遇到的常见问题，相信iOS9还有其它深坑有待挖掘，欢迎大家补充。

9、backbone实例todos分析（三）总结

在前两篇文章中，我们已经对这个todos的功能、数据模型以及各个模块的实现细节进行了分析，这篇文章我们要对前面的分析进行一个整合。前面我们说过，有了肉和菜，剩下的就是要怎么吃。我个人倾向于菜和肉一起吃，这样不会觉得腻 :-)

PMP 第9~10章错题总结

高层级的职责分配矩阵可界定哪些项目小组或单位分别负责工作分解结构的那一部分工作；而低层级职责分配矩阵则可在小组内，为具体活动分配角色、职责和授权水平 8.职权是使用项目资源、做出决策、签字批准、验收可交付成果并影响他人开展项目工作的权利 9.

PHP中9大缓存技术总结

30秒 max_input_time =600;每个PHP页面接收数据所需的最大时间，默认60 memory_limit =128M;每个PHP页面所吃掉的最大内存，默认8M 9、

Java9-17新特性总结

年底即将发布的SpringBoot3.0最低支持Java17版本 这里记录下新语法和值得注意的库 语法特性 module JDK9模块系统 Java 9 模块的重要特征是在其工件的根目录中包含了一个描述模块的 com.mycompany.common.DemoService with com.mycompany.sample.DemoServiceImpl; } Try-with-resources 允许有效地使用最终变量 JDK9java9 FileInputStream fis = new FileInputStream("test"); try (fis) { } 接口的私有方法 JDK9 interface ITest { / /必须有方法体 private void test () { } } 匿名内部类泛型 JDK9 interface Foo<T> { void test(T t); } 集合上，Java 9 增加 了 List.of()、Set.of()、Map.of() 和 Map.ofEntries()等工厂方法来创建不可变集合.

Android基础总结（9）——网络技术

" 5 android:orientation="vertical" > 6 7 <WebView 8 android:id="@+id/webView" 9 savedInstanceState) { 7 super.onCreate(savedInstanceState); 8 setContentView(R.layout.web_view); 9 match_parent" 5 android:orientation="vertical" > 6 7 <Button 8 android:id="@+id/button" 9 EditText responseText ; 6 7 private Handler handler = new Handler(){ 8 @Override 9 Message msg = new Message() ; 7 msg.what = SHOW_RESPONSE ; 8 msg.obj = response.toString() ; 9