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

建议sein.js 里面的代码注释使用英文,并且更加规范化 #9

Open
scut-lz opened this issue Aug 11, 2020 · 4 comments
Open

Comments

@scut-lz
Copy link

scut-lz commented Aug 11, 2020

sein.js 既然已经开源了,很多注释建议能够使用英文,并且去掉一些不规范的注释,对于接口的使用,注释能够规范化一些,可以参考three.js 里面的注释

@dtysky
Copy link
Member

dtysky commented Aug 11, 2020

英文在有足够需求的时候回添加。

PS:请问作者认为什么是不规范的注释,什么是规范的注释,举个例子?

@scut-lz
Copy link
Author

scut-lz commented Aug 12, 2020

不规范:
engine.ts 里面有类似这种注释
/**

  • 不要自己调用!
  • @hidden
    */
    public pauseGame(game: Game) {

@dtysky
Copy link
Member

dtysky commented Aug 13, 2020

不规范:
engine.ts 里面有类似这种注释
/**

  • 不要自己调用!
  • @hidden
    */
    public pauseGame(game: Game) {

这种方法是引擎内部方法,不暴露给开发者使用的,也不会出现在文档内,满足jsdoc规范。

@mytwz
Copy link

mytwz commented May 6, 2021

中文怎么了?我就问。这是中国人自己写的东西,怎么写上中文就是不规范了,开源就一定要英文啊。我们用老外的东西要学英文,老外用我们的东西我们就要给他们行方便?

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

No branches or pull requests

3 participants