Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
d66d2958
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
d66d2958
编写于
7月 27, 2023
作者:
O
openharmony_ci
提交者:
Gitee
7月 27, 2023
浏览文件
操作
浏览文件
下载
差异文件
!21439 【轻量级 PR】:update zh-cn/contribute/style-guide/style-guide-example-code-style.md.
Merge pull request !21439 from zyjhandsome/N/A
上级
274b8cfa
a09c2514
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
40 addition
and
15 deletion
+40
-15
zh-cn/contribute/style-guide/style-guide-example-code-style.md
.../contribute/style-guide/style-guide-example-code-style.md
+40
-15
未找到文件。
zh-cn/contribute/style-guide/style-guide-example-code-style.md
浏览文件 @
d66d2958
...
...
@@ -248,9 +248,9 @@ import window from '@ohos.window';
export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage) {
// 代码未格式化
windowStage.loadContent('pages/Index', (err, data) => {
});
// 代码未格式化,没有缩进
windowStage.loadContent('pages/Index', (err, data) => {
});
}
}
```
...
...
@@ -296,8 +296,6 @@ export default class EntryAbility extends UIAbility {
当一行注释内容过长时,注意断句切分到下一行呈现。
示例代码中的关键内容和逻辑需要添加注释来说明,以确保开发者理解代码的作用。
代码注释应该清晰、简洁、有用,能够方便别人理解代码的含义和作用。注释应该写在代码上方或右方。
【正例】
...
...
@@ -454,7 +452,10 @@ console.info('Succeeded in doing sthing.');
// 正例:
notificationManager.publish(notificationRequest, (err) => {
...
if (err) {
...
return;
}
console.info('Succeeded in publishing notification.');
});
```
...
...
@@ -464,13 +465,19 @@ notificationManager.publish(notificationRequest, (err) => {
```ts
// 反例1:使用console.log(...)可能会让程序员产生困惑,无法明确该日志信息是正常日志还是错误日志
notificationManager.publish(notificationRequest, (err) => {
...
if (err) {
...
return;
}
console.log('Succeeded in publishing notification.');
});
// 反例2:使用了console.error(...)而不是console.info(...)来打印正常日志信息。console.error通常用于打印错误信息,而不是正常的日志信息
notificationManager.publish(notificationRequest, (err) => {
...
if (err) {
...
return;
}
console.error('Succeeded in publishing notification.');
});
```
...
...
@@ -489,7 +496,10 @@ console.info('Succeeded in doing sthing.');
// 正例:
notificationManager.publish(notificationRequest, (err) => {
...
if (err) {
...
return;
}
console.info('Succeeded in publishing.');
});
```
...
...
@@ -499,19 +509,28 @@ notificationManager.publish(notificationRequest, (err) => {
```ts
// 反例1:
notificationManager.publish(notificationRequest, (err) => {
...
if (err) {
...
return;
}
console.info('Invoke publish success.');
});
// 反例2:
notificationManager.publish(notificationRequest, (err) => {
...
if (err) {
...
return;
}
console.info('Invoke publish successful.');
});
// 反例3:
notificationManager.publish(notificationRequest, (err) => {
...
if (err) {
...
return;
}
console.info('Invoke publish successfully.');
});
```
...
...
@@ -528,7 +547,10 @@ notificationManager.publish(notificationRequest, (err) => {
```ts
notificationManager.publish(notificationRequest, (err) => {
...
if (err) {
...
return;
}
console.info('Invoke publish succeeded.');
});
```
...
...
@@ -537,7 +559,10 @@ notificationManager.publish(notificationRequest, (err) => {
```ts
notificationManager.publish(notificationRequest, function (err) {
...
if (err) {
...
return;
}
console.info('Invoke publish succeeded.');
});
```
...
...
@@ -595,4 +620,4 @@ function createFile() {
// 关闭文件
fileio.closeSync(fileFD);
}
`
``
`
``
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录