v52.05 鸿蒙内核源码分析(静态站点) | 码农都不爱写注释和文档 原创

发布于 2021-10-20 17:01
浏览
1收藏

颜渊死,门人欲厚葬之,子曰:“不可。”门人厚葬之。子曰:“回也视予犹父也,予不得视犹子也。非我也,夫二三子也。” 《论语》:先进篇

v52.05 鸿蒙内核源码分析(静态站点) | 码农都不爱写注释和文档-开源基础软件社区

百篇博客系列篇.本篇为:

v52.xx 鸿蒙内核源码分析(静态站点篇) | 码农都不爱写注释和文档

前因后果相关篇为:

一键部署

直接下载或clone本项目到web服务器指定目录即可.

git clone https://gitee.com/weharmony/weharmony.git

码农都不爱写注释和文档

程序员都不愿意代码写注释和文档,自己也是一路这么过来的,面对海量代码却没有文档,痛苦不堪,追问文档往往换来一句 “代码就是最好的文档”,读源百遍,其意自现.这是一句正确的废话,背后得烧掉了多少时间.等一番寒彻苦,搞懂了之后同样也是不愿写文档,没时间没必要,用同样的话去回应新人对文档要求,何其相似.

点赞鸿蒙的文档

2020/9/10 鸿蒙正式开源后自己用业余时间对鸿蒙内核源码项目kernel_liteos_a_note进行中文注解,高频的接触官方文档,看网上有不少喷官方文档的,往往以偏概全,发现个错误就放大,须知鸿蒙生态何其庞大,有失误和错漏很正常,坦白说鸿蒙文档做的挺不错的,点赞,内容更新也很频繁,因 weharmonyos.com 每周都会同步官方文档,所以很清楚每次都有大的调整,希望多用欣赏的眼光来看鸿蒙,换位思考 u can u up , 你来未必能做的比现在好. 不要手里拿个锤子看什么都像钉子,干就完了.

为什么会有 weharmonyos.com

  • 在给鸿蒙内核加注和写博客期间需要不断的查找资料,觉得官方目前资料展示方式并不能满足自己的需求,浪费了很多宝贵的时间,所以在想能不能将官方文档(md格式)做个静态站点出来,即方便别人更方便自己,这是一劳永逸,利己利他的事干嘛不做的,刚好五一有成块的时间,本来也想出去走走,结果哪都没去,期间遇到不少问题,但基本都解决了,

  • 目前保持每周一次的频率同步官方文档,也想过做成实时更新,但难度很大,因官方文档还不能直接生成静态页面,编译通不过,需要手动去核对和修改.另外导航栏和侧边栏在官方文档的基础上做了索引优化和结构调整,但内容没有做任何的更改,放心使用.

  • 鸿蒙研究站的另外一部分是对百篇博客的实时输出,百篇博客内容在其他主流技术站点也有输出,但因各平台的规则不同,更新会较慢,weharmonyos.com上的内容是最新的.其它平台输出如下,感谢这些平台一直以来的支持:

  • 这里必须要感谢下这套主题的作者 Mr.hope ,人非常的nice, 一直帮着解决问题.再次感谢!!! 主题地址:vuepress-theme-hope 有兴趣的可以去了解下,一个功能强大的 vuepress 主题.

模块首页

openharmony开发文档首页,内容来源于鸿蒙官方文档

v52.05 鸿蒙内核源码分析(静态站点) | 码农都不爱写注释和文档-开源基础软件社区

百篇博客分析首页

v52.05 鸿蒙内核源码分析(静态站点) | 码农都不爱写注释和文档-开源基础软件社区

导航栏

便捷的导航,让你想去哪就去哪,例如:
鸿蒙生态开发主要分两大方向:

  • 南向设备开发
    • 轻型系统开发 : liteos-m 内核
    • 小型系统开发 : liteos-a 内核
    • 标准系统开发 : linux 内核
  • 北向应用开发

v52.05 鸿蒙内核源码分析(静态站点) | 码农都不爱写注释和文档-开源基础软件社区

侧边栏

便捷索引,处处入口

v52.05 鸿蒙内核源码分析(静态站点) | 码农都不爱写注释和文档-开源基础软件社区
v52.05 鸿蒙内核源码分析(静态站点) | 码农都不爱写注释和文档-开源基础软件社区

离线文档

离线文档同步线上内容

v52.05 鸿蒙内核源码分析(静态站点) | 码农都不爱写注释和文档-开源基础软件社区

搜索极为便利

码农每天离不开的就是搜索
v52.05 鸿蒙内核源码分析(静态站点) | 码农都不爱写注释和文档-开源基础软件社区

主题色

v52.05 鸿蒙内核源码分析(静态站点) | 码农都不爱写注释和文档-开源基础软件社区

  • 多种主题色,可以根据您的选择,当前时间自动切换模式,码农们得保护好视力,个人偏好白色.

微信 | QQ 群

前往 >> http://weharmonyos.com/qun.html

捐赠记录,再次感谢!!!

前往 >> http://weharmonyos.com/donate.html

百篇博客分析.深挖内核地基

  • 给鸿蒙内核源码加注释过程中,整理出以下文章。内容立足源码,常以生活场景打比方尽可能多的将内核知识点置入某种场景,具有画面感,容易理解记忆。说别人能听得懂的话很重要! 百篇博客绝不是百度教条式的在说一堆诘屈聱牙的概念,那没什么意思。更希望让内核变得栩栩如生,倍感亲切.确实有难度,自不量力,但已经出发,回头已是不可能的了。 😛
  • 与代码有bug需不断debug一样,文章和注解内容会存在不少错漏之处,请多包涵,但会反复修正,持续更新,v**.xx 代表文章序号和修改的次数,精雕细琢,言简意赅,力求打造精品内容。

按功能模块:

百万汉字注解.精读内核源码

四大码仓中文注解 . 定期同步官方代码

v52.05 鸿蒙内核源码分析(静态站点) | 码农都不爱写注释和文档-开源基础软件社区

鸿蒙研究站( weharmonyos ) | 每天死磕一点点,原创不易,欢迎转载,请注明出处。若能支持点赞则更佳,感谢每一份支持。

©著作权归作者所有,如需转载,请注明出处,否则将追究法律责任
1
收藏 1
回复
举报
回复
添加资源
添加资源将有机会获得更多曝光,你也可以直接关联已上传资源 去关联
    相关推荐