说说数仓(10)-任务注释

---

数仓总结目录：
说说数仓(1) - 什么是数仓
说说数仓(2) - 传统数仓与互联网数仓
说说数仓(3) - 数仓架构
说说数仓(4) - 指标字典
说说数仓(5)-最重要的维度之日期维度
说说数仓(6)-关于命名规范
说说数仓(7)-浅谈数据治理
说说数仓(8)-关于增量
说说数仓(9)-上下游约定
说说数仓(10)-任务注释

---

这一篇说说注释，注释总是让人又爱又恨。
没有注释，谁知道你这些代码是用来干嘛的，从代码角度来看，你想做的是A，而实际上需求确是B，具体干啥得靠猜；
代码有注释，也不一定就可以高枕无忧，注释可能是最初版的需求，改了几版后，代码早就变了，注释没有变，注释和代码不匹配，谁知道该以哪个为准啊。

我们的数仓都是基于阿里云的，使用了它的DataWorks作为离线工具，所有的代码都在这上面，所以这里简单介绍下，在阿里云上的任务，几点注释规范。

--    @name p_dwd_rack_machine
--    @description 货架宽表
--    @target rack.dwd_rack_machine
 
--    @source owo_ods.kylin__machine_release_his
--    @source owo_ods.kylin__machine_device_his
 
--    @author yuguiyang 2017-12-25
--    @modify

@name：任务的名字，我们的任务名一般都是以 p_目标表名，后来阿里的DataWorks升级后，推荐是任务名和表名保持一致。

@description：任务描述，该任务的主要内容
@target：目标表名，一般一个任务只输出一个目标表

@source：来源表，就是任务中使用的底层表，这里也可以省略，从血缘关系中可以直接看到，而且很容易漏更新

@author：创建者，和创建日期，
@modify：内容变更记录，变更人，变更日期，变更原因 ，这个从版本控制中也可以找到，但是这些这里更直观一些。