未验证 提交 a09c2514 编写于 作者: zyjhandsome's avatar zyjhandsome 提交者: Gitee

update zh-cn/contribute/style-guide/style-guide-example-code-style.md.

优化“【规则】代码格式化”和“notificationManager.publish示例代码相关的规则/建议”
Signed-off-by: zyjhandsome's avatarzyjhandsome <zyjhandsome@126.com>
上级 274b8cfa
......@@ -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.
先完成此消息的编辑!
想要评论请 注册