julelang / jule

Effective programming language to build efficient, fast, reliable and safe software while maintaining simplicity
https://jule.dev
BSD 3-Clause "New" or "Revised" License
133 stars 13 forks source link

[PROPOSAL] Add documentation in the code #35

Closed Panquesito7 closed 1 year ago

Panquesito7 commented 1 year ago

Detailed description

It'd be great if the whole JuleC codebase was documented so that people that contribute or are just trying to learn Jule and C++ find it easier to understand the code, thus, attracting more users and more potential contributions.

Context

Adding documentation would help in a few ways. Here are some:

Possible implementation

No response

Additional information

This is not something critical, and should probably be done once Jule is fairly stable and more popular.

mertcandav commented 1 year ago

I've added some more documentation comments to the code. But I don't find it necessary to explain all the code in detail. The code makes most things understandably readable with define identifiers and stuff. Where documentation is needed in the code will be identified and documented over time, it's a natural process of development, so no specific workflow will be created to make this.

Thanks for your contribution.