一个在线阅读OpenHarmony全量代码的网站

点击蓝字 ╳ 关注我们

开源项目 OpenHarmony

是每个人的 OpenHarmony

冷钦街

以下内容来自嘉宾分享，不代表开放原子开源基金会观点

一、背景

当前，OpenAtom OpenHarmony（以下简称“OpenHarmony”）项目持续发展，其代码量已经超过了20G字节的存储占用空间，对于一个普通学习者（如刚入门的学生）来说，成本很高。主要体现在如下三个方面：

• 下载方式复杂：zh-cn/device-dev/get-code/sourcecode-acquire.md · OpenHarmony/docs - Gitee.com从官方代码仓可以看出，仓库多，下载方式复杂。

• 占用空间大：目前已经是有超过20G的存储占用，未来还会持续增加。

• 搜索效率低：函数、变量等符号全文搜索效率低，严重降低学习代码的效率。

解决办法

针对以上的学习痛点，我研发了OpenHarmony全量代码在线检索系统，并为此提出了以下解决方案：

• 通过服务器提前下载好全量代码，并提供web服务供在线浏览。

• 同时，对源代码基于语言语法进行分析并建立符号索引数据库，快速搜索符号的定义以及使用。

• 再者，还支持站内文本快速搜索，即根据普通字符串搜索所有代码、注释、帮助文档等。

二、源码在线检索系统使用手册

主要分如下四方面讲解：

• 源码浏览

• 标识符搜索

• 普通文本搜索

• 代码比较

2.1 源码浏览

下图为OpenHarmony源代码的根目录。当前默认是master版本代码，可以点击“release_3_1”切换代码版本。

接着可以点击文件名(如此处的build.py)进入文件视图

1、文件视图中会显示文件的行号，页面顶部会显示文件的所在路径，可以单击路径字符串快速到达其中任何一个目录。

2、在文件视图中，蓝色部分的文字可以单击，单击以后，就来到了标识符搜索视图。

2.2 标识符搜索

标识符搜索视图可以是文件视图跳转过来，如本例，也可以是点击右上角的“identifier search”链接切换过来（此时需要在“Identifier”输入框中输入需要查询的符号）。

与本标识符相关的定义和引用会被罗列出来，对应的文件和行号都会标识清楚，点击“行号”可以跳转到相应的文件视图。

2.3 普通文本搜索

对于代码注释中的文本或者文档中的文本信息，需要使用普通文件搜索“General search”，如下图。

在“Or containing”对话框中输入get_python字符串，可以看到普通搜索到了80处。

2.4 代码比较

本系统支持将不同版本的代码进行比较。以master和release_3_1为例，首先进入文件视图，然后点击右上角的文本比较文字链接“Diff markup”。

最后选中另一个需要比较的版本，如这里的release_3_1。然后就能看到2个版本的具体差异。

下图可以明显看出两个版本之间的差异：

三、总结

根据以上的操作，开发者可以在网站（https://www.lengqinjie.xyz）进行OpenHarmony全量源码在线浏览。站点支持标识符搜索、文本匹配搜索、代码比较，支持master版本和release_3_1版本，并保持每日更新。这将极大地提高代码阅读和查找的效率，帮助开发者更加高效地了解和使用OpenHarmony。

---

原文标题：一个在线阅读OpenHarmony全量代码的网站

文章出处：【微信公众号：OpenAtom OpenHarmony】欢迎添加关注！文章转载请注明出处。