Hello Everyone! 👋
Here I am with a new update to my project "DeadLock".
Yesterday after initialising the repository. I tried to create a test notebook using the fstream library. You can check out the code on my GitHub.
I also did some research on how to make my code more "human-friendly" and got some interesting results:
- I will not be adding too many comments, contrary to what most people say. Comments will be added but to only those places which require some additional context to whatever is going on in the code file.
- When you checkout the repo and ultimately see my other projects, you will see a bad practice of naming variables with a single word. But this won't happen with this project, and I will make sure that I am as explicit as possible with the naming schemes, which I got to know about through this video.
- For documentation, I will be using Doxygen, the most popular C++ docs generator.
And, if you look at my profile, you will see that I am still a college student, and I still didn't know about these things until now. Also, I'll have to first study these while also maintaining my academics and the project, so I apologize right now itself that the upcoming commits may contain less code than this one. Please bear with me or you can contribute yourself either through code or just recommend me what you'd like to see more. I can't promise but I'll try my best to fulfil your expectations.
Thank You Reader! 🫡
Top comments (0)