fogleman/Craft

Code Documentation

dabockster opened this issue · 4 comments

dabockster commented

There is very little documentation available for the source code. As such, the source is highly difficult to understand and interpret by others. Please consider adding in appropriate documentation as soon as possible.

crazyBaboon commented

And yet, because it is written in C, it is still easier to understand than the utter mess going on in Minetest C++ source code.

  • 👍5
htmlboss commented

I find the code fairly readable to be honest (and I'm coming from a c++ background). Yes it's very long-winded in places but try breaking things into chunks in your mind.

crazyBaboon commented

Unfortunately this project seems to be dead.

ignacionr commented

@dabockster I am helping a person just out of high school learn C, and they find it very easy to read. IMHO, including comments within the code would lead to disconnects and bloat the line number count, discouraging people to read the actual C language.

@crazyBaboon the project is not dead. The maintainer has been accepting PRs. What I think is happening, is that he simply disregards issues that should be addressed by the same posters (e.g. if my proposal would be to have documentation, then I would offer a PR with .md files).

  • 👍1