Skip to content

Better code style #27

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

Open
TapiocaFox opened this issue Nov 19, 2019 · 6 comments
Open

Better code style #27

TapiocaFox opened this issue Nov 19, 2019 · 6 comments

Comments

@TapiocaFox
Copy link
Member

https://devdocs.io/jsdoc

@idoleat
Copy link
Member

idoleat commented Nov 19, 2019

I saw many people use this
http://www.sphinx-doc.org/en/master/
example: https://docs.godotengine.org/en/3.1/

Also this
https://www.mkdocs.org/
Seems like less people using it. Any way it highlight the markdown feature.

@idoleat
Copy link
Member

idoleat commented Nov 19, 2019

Some people use wiki
https://geom.io/bakery/wiki/index.php?title=Manual

Also GitHub's wiki

@TapiocaFox
Copy link
Member Author

But most of the snippets that I saw on the web use this code style. Moreover, I also checked for the google's standard which is the similar code style.

@TapiocaFox
Copy link
Member Author

And I prefer documenting within the code. Instead of separating files. Regarding the benefits for coders who would like to inspect raw code. And also for our rapidly changing codebase.

@idoleat
Copy link
Member

idoleat commented Nov 19, 2019

And I prefer documenting within the code. Instead of separating files. Regarding the benefits for coders who would like to inspect raw code. And also for our rapidly changing codebase.

I got your point. We use the in-code document on game development as well 😁 (The built-in feature of C#) I was just referring some well know tools

@TapiocaFox
Copy link
Member Author

Thx you sir. UuU

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

2 participants