强烈建议大家关注编程规范,这就好比是一个开源社区的代码层面的宪法,如果你希望推动中文注释进主库,你要首先了解编程规范是否允许这样做。

OpenHarmony的编程规范在这里可以找到:
https://gitee.com/openharmony/docs/blob/master/zh-cn/contribute/%E8%B4%A1%E7%8C%AE%E4%BB%A3%E7%A0%81.md 
现在规范也在补充和完善中,很快发布。

在C/C++的规范当中都有明确说明使用英文进行注释。至于这样规定的原因,背后也是血泪的教训积累出来的,原因也与什么民族情怀没关系。

希望每个致力于OpenHarmony的开发者都了解编程规范,学习编程规范,履行编程规范,只有这样,跨地域,跨公司的合作开发才成为可能,最终输出代码的质量才是划一的,优秀的。





962030@qq.com
 
发件人: weharmony@126.com
发送时间: 2021-12-01 19:19
收件人: 李传钊; 杜天微; 开源鸿蒙开发组
主题: 回复: [Dev] 回复:回复:回复:关于代码中使用中文注释的问题
支持中文注解,但不支持合入主库,原因有三:
1. 中文注解是希望将母语为汉语的自己人尽可能多的卷进来, 得有人把被子捂热了.年轻人血气方刚, 中文注解有助于节约时间成本,加强交流,参与人多了创意创新自然就有了. 
2. 国际化是需要将外国优先人才卷进来,让场子更热,得让人待着舒服, 这就需要对接国际标准,规范,得有谦虚,包容,开放的心态,不能有民族自尊心作祟.
3. 中文注解还有一个目的是要帮助主库完善英文注释, 让文档/函数/变量 表达言简意赅,用词精准,让别人看不出这是来自中国的代码, 从而提高国内开发者的整体英文水平.



weharmony@126.com
 
发件人: 李传钊 via dev
发送时间: 2021-12-01 17:41
主题: [Dev] 回复:回复:回复:关于代码中使用中文注释的问题
要加强学习,提高讨论的质量,不要随意占用大家的时间。

---原始邮件---
发件人: "杜天微 via dev"<dev@openharmony.io>
发送时间: 2021年12月1日(周三) 下午5:31
收件人: "开源鸿蒙开发组"<dev@openharmony.io>;
主题: [Dev] 回复:回复:关于代码中使用中文注释的问题


国际化。
不是注释,是指南、手册。

OH,也有这个东西。

https://gitee.com/openharmony/docs/tree/master/en




在 2021-12-01 16:43:45,"刘允礼 via dev" <dev@openharmony.io> 写道:

我倒是很想听听你们对这个路径下文件的意见
https://github.com/torvalds/linux/tree/master/Documentation/translations/zh_CN


2021年11月30日 23:26Luo Xiaogang via dev<dev@openharmony.io> 写道:

我坚决反对在代码中加入中文注释。

在代码中加入中文注释,有没有考虑过 写代码的人的感受?
有没有考虑过 看代码的人的感受?
还是说这些要求在代码中加入中文注释的人从来不写代码,也不看代码?

前面回复的几封邮件,主题已经是乱码了,让使用者如何理解?
1、中文注释,会让开发者在中英文输入状态下反复切换,体验极差,还有一些语法问题。
2、中文注释,对于阅读者,不同的编码方式,会导致乱码。如果10个文件,有多种文件编码方式,怎么看??有 utf-8,gb2312, gb18030 等等。
3、是不是 commit message 也要中文注释?如果这样,git log 就非常难用了。
4、如果系统是纯英文的,怎么写中文注释?我们需要有一个开放的心态,需要国际视野,不能仅仅局限于国内。

关于如何写注释,如果不会,可以去学习 宋宝华老师 的视频课程:《编写高质量注释之道

代码应该是自注释的,应该是很容易理解的,而不是晦涩难懂的。如果是晦涩难懂的代码,说明代码的质量有问题,需要改进。

注释 更多的是描述 代码背后的故事,而不是代码本身。

建议大家多研究一下 linux 的代码,包含代码风格、代码质量、架构、注释等。



在 2021-11-28 21:05:38,"泛舟西湖 via dev" <dev@openharmony.io> 写道:

狭隘民族主义要不得,光喊口号没用,
科技尽量远离政治
看过计算机架构组织原理,应该知道怎么做
不懂就学,比较花两个字节存储一个汉字
以及各种乱七八糟编码变换,都是巨型内卷

---Original---
From: "962030--- via dev"<dev@openharmony.io>
Date: Fri, Nov 26, 2021 16:07 PM
To: "15390014138"<15390014138@163.com>;"Netroby"<hufeng1987@gmail.com>;
Cc: "朱其罡"<qigang@openatom.org>;"刘允礼"<ylliu3788@163.com>;"dev"<dev@openharmony.io>;
Subject: [Dev] ظ : Re: Re: 뿪ͨcn_comment ֧

就是要振兴中华才要用英文写注释,操作系统作为IT基础设施,光在窝里横是没前途的,基金会现在已经跟eclipse基金会合作开启了名为Oniro的欧洲发行版。
不仅要用英文写注释,还要写好,写的精准,这是能耐,这不是什么崇洋媚外。不仅要写好英文注释,还要写好英文文档,还要写好英文log信息,还要规范代码里不好的变量命名。


李传钊
 
发件人: 15390014138
发送时间: 2021-11-26 12:38
收件人: Netroby
主题: Re:Re: [Dev] Re: 申请开通cn_comment分支
基于代码注释这个任务,主要作用是2点:
1. 参与本项目的学生接触OH代码,学习知识并沉淀。这个放普通的仓库即可。
2. 未来需要加入OH的学生,需要一个方便的查看含注释代码的渠道,如果是在主仓中的话,更方便,省去了推广,否则还需要推广成本,告诉学生哪里有含中文注释的代码可以看。

如果推广这个难度不用担忧的话,我个人觉得确实没有必要放主仓。







在 2021-11-26 11:22:19,"Netroby" <hufeng1987@gmail.com> 写道: >大佬们好。 >我绝对支持中文注释, >原因是:英文是大英帝国殖民遗留的历史问题。大英帝国旗帜插在哪里,英语就在哪里。 > > >而中文,自古以来就是中国官方行文官方语言。 > >中文至少得到支持,不应该被放弃。 > >我们中国的开源项目,为什么不用中文?为什么要用英文作为主语言。 > >我100支持中文。 > >英文可以学,可以支持,但不应该为英文放弃中文。 > >自强不息,从我辈做起,如果我们自甘泯灭自己的文化和传统。不学中文,不用好中文。 > >都不用美帝国主义制裁,我们自己就不行了。 > > >Appreciate your time. >---------------------------- >Netroby > >朱其罡 via dev <dev@openharmony.io> 于2021年11月26日周五 上午11:09写道: >> >> 开发者成长计划中的代码注释环节,意图是让学生去了解OH代码,尤其是那些无法下手写代码的去初步了解,设置的赛题数量和奖金都是偏低的,反馈社区的贡献不在计划目标范围内。 >> 注释可以以独立的形式在社区去做和传播,交流。 >> 注释是否能进主库听从PMC的专业指导意见,需保持社区代码的高质量。 >> >> 朱其罡 >> 手机:13701234598 >> OpenHarmony项目群工作委员会生态建设组 >> >> >> >> ------------------ Original ------------------ >> From: "刘允礼 via dev"<dev@openharmony.io>; >> Date: Thu, Nov 25, 2021 04:48 PM >> To: "'962030'"<962030@qq.com>; >> Cc: "15390014138"<15390014138@163.com>; "dev"<dev@openharmony.io>; >> Subject: [Dev] Re: 申请开通cn_comment分支 >> >> >> 钊哥,OHOS要开放就必然面临群体成员能力不一致的问题。加入中文注释不应该回避。我的建议是必须用英文注释,可以提供中文翻译作为辅助。 >> >> 学生群体是潜在的巨大力量,不应排斥,应给予充分的成长空间。 >> >> >> 代码会持续更新,不建议使用分支进行管理。 >> >> >> 在 2021-11-25 15:58:51,"962030--- via dev" <dev@openharmony.io> 写道: >> >> OHOS的编程规范有明确约束,要使用英文进行注释,因此强烈不建议在主库当中加入类似这样的中文注释内容。 >> 另外,学生们的水平我们要有客观认识,他们的输出不足以直接合入主库。 >> 李传钊 >> >> 发件人: 15390014138--- via dev >> 发送时间: 2021-11-17 20:57 >> 收件人: dev >> 主题: [Dev] 申请开通cn_comment分支 >> 尊敬的PMC以及各成员: >> >> >> 目前openharmony开发者成长计划第二期题目中含有文档和代码注释类题目。 >> 经过成长计划会议讨论,决定在主仓库内创建分支(分支名称暂定cn_comment, 即中文注释版本),方便未来参与者学习。 >> >> >> 申请在openharmony主仓内部分代码仓库创建cn_comment (名称待定)分支,用于补充注释和文档 >> 当前阶段影响的仓库有: >> https://gitee.com/openharmony/communication_ipc_lite >> >> https://gitee.com/openharmony/communication_ipc >> >> https://gitee.com/openharmony/communication_dsoftbus >> >> https://gitee.com/openharmony/distributedschedule_samgr_lite >> >> https://gitee.com/openharmony/distributedschedule_samgr >> >> https://gitee.com/openharmony/distributedschedule_safwk_lite >> >> https://gitee.com/openharmony/distributedschedule_safwk >> >> https://gitee.com/openharmony/aafwk_aafwk_lite >> >> https://gitee.com/openharmony/aafwk_standard >> >> https://gitee.com/openharmony/appexecfwk_appexecfwk_lite >> >> https://gitee.com/openharmony/appexecfwk_standard >> >> >> >> >> >> 冷钦街 >> _______________________________________________ >> dev mailing list -- dev@openharmony.io >> To unsubscribe send an email to dev-leave@openharmony.io >> >> >> >> >> >> _______________________________________________ >> dev mailing list -- dev@openharmony.io >> To unsubscribe send an email to dev-leave@openharmony.io