Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update codereview docs for team1. #76

Merged
merged 1 commit into from
Feb 29, 2024

Conversation

IRONICBo
Copy link
Contributor

Update our review comments in team1



* https://github.com/goplus/community/pull/148#discussion_r1494609866
* 代码风格,尽量遵循Go的风格,尤其是命名,减少map等不固定长度的数据结构作为参数或者返回值
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

减少map等不固定长度的数据结构作为参数或者返回值 这一句哪里有出处吗?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Golang好像没有具体的条例限制,但是有侧面反应推荐使用结构体,主要基于类型安全和代码可读性的考虑。结构体提供了明确的类型信息

部分社区中的反馈:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

在一些场景下,明确的结构体确实是能增强可读性,但直接推到为结论 减少map等不固定长度的数据结构作为参数或者返回值 有点过于武断。

实际上在我看来,在具体业务场景下这些决策是顺水渠成的。

比如我们这里,确实是不推荐直接用map,因为这里它应该固定长度的,且有明确语义。而这个语义,可能还需要别人理解的,所以用一个明确的名字会更好。

@IRONICBo IRONICBo force-pushed the docs/20240221-review-comments branch from 6a98284 to 8fea5f6 Compare February 26, 2024 08:20
@IRONICBo IRONICBo force-pushed the docs/20240221-review-comments branch from 8fea5f6 to c8b3c1b Compare February 26, 2024 08:21
@CarlJi CarlJi merged commit 39db751 into qiniu:master Feb 29, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants