ش | ی | د | س | چ | پ | ج |
1 | 2 | 3 | ||||
4 | 5 | 6 | 7 | 8 | 9 | 10 |
11 | 12 | 13 | 14 | 15 | 16 | 17 |
18 | 19 | 20 | 21 | 22 | 23 | 24 |
25 | 26 | 27 | 28 | 29 | 30 | 31 |
مستند سازی کد در پایتون :
فرض کنید برنامه ای نوشته اید که دارای هزار خط کد است و در آن از متغیرها ، دستورات و سایر عناصر اصلی یک زبان برنامه نویسی مانند حلقه ، تابع ، کلاس و دیگر رهنمون ها و ساختارهای برنامه نویسی که در آینده با آنها آشنا خواهید شد استفاده کرده اید. و برای دستیابی به اهداف مشتری و حل برخی از مسائل گوناگون دنیای کسب و کار و پیاده سازی منطق تجاری ، الگوریتم های پیچیده ای را طراحی و کد نویسی کرده اید. برنامه شما پس از پایان پروژه و پشت سرگذاشتن چندین آزمون درستی کارکرد و تایید اولیه ، به مشتری تحویل داده می شود و در محیط واقعی و عملیاتی سازمان مشتری مستقر و اجرا می گردد. شش ماه پس از تحویل ، بازخوردهای داده شده از مشتری نشان می دهد که بخشی از برنامه ، خواسته های مشتری را بدرستی برآورده نمی سازد و نیاز به اصلاح و تغییر دارد. شما در این مدت منطق تجاری و فلسفه حاکم بر طراحی و پیاده سازی بسیاری از الگوریتم های کد نویسی شده در برنامه را از یاد برده اید و باید زمان بسیار زیادی را صرف خواندن خط به خط کد و درک مجدد منطق برنامه و یافتن مشکل کنید بدتر از این زمانی است که بنا بر تصمیم مدیران شرکتی که در آن کار می کنید فرد دیگری مسئول بروزرسانی و اصلاح این کد شود . خدا به چنین فردی رحم کند ،کد شما بدون توضیحات و مستند سازی لازم ، همانند کلاف سردرگمی است که بازکردنش گاو نر می خواهد و مرد کهن.
ادامه مطلب ...