DTubeGo
DTubeGo copied to clipboard
dtube
Create readme + Comment code
The code is mostly not commented so new cintributors will not understand the logic easily. Also there is no readme currently. We should work on both.
Because I am going through the entire code to get the ios build working.. I can add comments. I will follow these official guidelines https://dart.dev/guides/language/effective-dart/documentation https://sodocumentation.net/dart/topic/2436/comments
I also suggest others to follow this so that we can produce nice automatic documentation.
Great man! Coolio. I will read those and add comments as well. Better to have more than less :)
But I guess you don't need to crawl through the whole code to success with the ios build. I think it will hang on a few little things like setting up permissions, adding additional parameters to only a few methods were using from foreign dependencies or the flutter version as already mentioned.
Andy Khan (Ananda) @.***> schrieb am Mi., 6. Okt. 2021, 17:07:
Because I am going through the entire code to get the ios build working.. I can add comments. I will follow these official guidelines https://dart.dev/guides/language/effective-dart/documentation https://sodocumentation.net/dart/topic/2436/comments
I also suggest others to follow this so that we can produce nice automatic documentation.
— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/tibfox/dtube_togo/issues/115#issuecomment-936460024, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABN5VKQW42LVHJ6QSWYRFX3UFRQ2HANCNFSM5FCAXFKA .
@brishtiteveja sorry but I thought about it and perhaps it is not the best idea to work on the commenting until we have a good and stable version. I restructured a lot and will need to continue to have a understandable folder system. Also a few recent errors showd that there can be big differnces between release mode and debug mode and perhaps we have to rework a lot more. I hope not but if we need to the widgets could get split or combined or whatever sooo commenting is not the best idea if you are not always on the latest version. I think merging the comments will be way more work than needed :P