HarmonyOS 鸿蒙Next官方代码可读性

HarmonyOS 鸿蒙Next官方代码可读性

官方SDK里的各种API能不能把大量无意义的注释删掉，像下面这种注释有何意义？

cke_820.png

随便点开一个代码文件就是几万行，非常难以阅读，就像在一盆满满的瓜子壳里面找瓜子仁一样毫无意义：

cke_4849.png

我是一名iOS开发，这几天刚接手鸿蒙项目，看官方api看的快要猝死在工位上了。看一下iOS的官方api文档，一看就懂，一眼看完的api，加那么多无意义的注释干嘛：

cke_29532.png

虽然有这个接口列表，但是窗口很小，每次都要在项目目录和接口列表之前切来切去，想看点某个api看看，又都是无意义的注释：

cke_41178.png

看文档看累了，吐槽一会，-_-||


更多关于HarmonyOS 鸿蒙Next官方代码可读性的实战教程也可以访问 https://www.itying.com/category-93-b0.html

2 回复

HarmonyOS鸿蒙Next的官方代码在可读性上进行了优化，采用了清晰的模块化设计和规范的命名规则。代码结构层次分明，注释详细，便于开发者快速理解和使用。鸿蒙Next的API设计遵循一致性原则，减少了学习成本。此外，官方提供了丰富的文档和示例代码，进一步提升了代码的可读性和可维护性。

更多关于HarmonyOS 鸿蒙Next官方代码可读性的实战系列教程也可以访问 https://www.itying.com/category-93-b0.html


作为HarmonyOS开发者，我理解你的困扰。确实，HarmonyOS Next的API文档目前存在以下特点：

  1. 详细注释是为了满足不同层次开发者的需求，特别是刚接触HarmonyOS的开发者。这些注释包含了参数说明、返回值、使用示例等完整信息。

  2. 代码量大的原因是HarmonyOS作为一个全场景操作系统，需要支持多种设备类型和复杂场景，API设计上需要考虑更多兼容性和扩展性。

  3. 建议可以：

  • 使用IDE的代码折叠功能隐藏注释
  • 通过API参考文档快速查阅接口定义
  • 利用搜索功能直接定位需要的API

HarmonyOS团队正在持续优化开发体验，后续版本会考虑改进文档的可读性。目前阶段需要开发者稍作适应。

回到顶部