نحوه داکیومنت کردن کدها

سلام وقت بخیر

این که شما یه کدی رو نوشتین و بعد از مدتی در مورد عملکرد اون کدها ابهام دارید به این دلیل هست که برای کدهای خودتون توضیح یا کامنت قرار ندادید که متوجه بشید

حتما از کامنت و یادداشت گذاری استفاده به جا داشته باشید

مورد بعدی هم این هست که کد نویسی تمیز و اصولی داشته باشید که هر موقع به کد ها نگاه کردید متوجه بشید که دقیقاً عملکرد اون ها چیه 

سلام دلیلش چیه که جواب ندادین ؟؟؟؟؟؟؟؟

سلام و احترام

سعی کنید برای کدی که مینویسید حتما یه کامنتی براش بنویسید، مثلا حتما بنویسید که این تابع چی کار میکنه، ورودی هاش چیه، خروجیش چیه و از این جور موارد تا وقتی بعدا اومدید سراغش بتونید به یاد بیارید داره چی کار میکنه.

این نکات رو در مورد مستند کردن کدها بخونید که به کارتون میاد

https://guides.lib.berkeley.edu/how-to-write-good-documentation

سلام