search

legend2ks / YoutubeDownloader

YouTube video/playlist/channel downloader
GNU Lesser General Public License v2.1
186 stars 30 forks source link

No comments in code #13

Open Neurofibromin opened 5 months ago

Neurofibromin commented 5 months ago

There are very few comments in the source code, making it hard to read. Do you plan to add more? Also some overview explanation about the software architecture would be very welcome. Great project otherwise!

LazaroOnline commented 4 months ago

No comments in source code is a good thing. Maybe what you mean is you would like to find more documentation, for example in markdown files, or that the code would be cleaner so that it is easier to read.

LazaroOnline commented 4 months ago

By the way, I cloned this repo (and the git submodule), executed it, and got the error message: "Failed to connect to Aria2", but I don't see any documentation on how to get the repo working. It would be nice to have a doc or script that initializes all that this repo requires so I can run it without manual steps.

LazaroOnline commented 4 months ago

I found the solution to make the app work, it would be nice to add this to the docs:

## Project Setup
Next to the "`YoutubeApp.exe`" main app, create a folder named "utils" and get these 3 files from the internet:
- "aria2c.exe" from https://github.com/aria2/aria2/releases (look for the releases file download `aria2-1.37.0-win-64bit-build1.zip`).
- "yt-dlp.exe" from https://github.com/yt-dlp/yt-dlp/releases (look for the `yt-dlp.exe` file)
- "ffmpeg.exe" from https://github.com/BtbN/FFmpeg-Builds/releases (for example the `ffmpeg-master-latest-win64-gpl.zip` and extract the `ffmpeg.exe`)
Neurofibromin commented 4 months ago

No comments in source code is a good thing. Maybe what you mean is you would like to find more documentation, for example in markdown files, or that the code would be cleaner so that it is easier to read.

Hard disagree. Good comments help understanding and make code more readable. Although I admit, this is a highly debated topic in the community, it would seem that most major projects also use comments. https://stackoverflow.blog/2021/12/23/best-practices-for-writing-code-comments/

Also bringing up a totally different problem in this issue is inappropriate, please open a new issue for those instead of discussing them here.

LazaroOnline commented 4 months ago

This issue is too generic and open ended, what amount of comments, where, about what in particular are you expecting? I didn't mean to bring another subject, instead I materialized it into a real scenario that is understanding how to setup the project for local execution and gave a solution to it in a PR. You can keep adding more specific subjects you would like to find more comments/docs about.

About comments, for sure "good" comments are great specially when they explain the questions "why" the code is that way, but sometimes there is just nothing worth commenting down, I don't know if it is the case for this repo or not, but the issue sounds like saying "No comments >> therefore the code is hard to read", which is not necessarily true.