در این مطلب، ویدئو مستندسازی در مقابل کد نظر دادن در پایتون با زیرنویس فارسی را برای دانلود قرار داده ام. شما میتوانید با پرداخت 15 هزار تومان ، این ویدیو به علاوه تمامی فیلم های سایت را دانلود کنید.اکثر فیلم های سایت به زبان انگلیسی می باشند. این ویدئو دارای زیرنویس فارسی ترجمه شده توسط هوش مصنوعی می باشد که میتوانید نمونه ای از آن را در قسمت پایانی این مطلب مشاهده کنید.
مدت زمان فیلم: 00:05:19
تصاویر این ویدئو:
قسمتی از زیرنویس این فیلم:
00:00:00,030 –> 00:00:02,669
به بخش سوم آموزش واقعی پایتون
2
00:00:02,669 –> 00:00:04,470
برای مستندسازی کد پایتون خود
3
00:00:04,470 –> 00:00:07,189
در زمینه مستندسازی در مقابل اظهار نظر
4
00:00:07,189 –> 00:00:09,120
قبل از شروع مستندسازی کد خود خوش آمدید
5
00:00:09,120 –> 00:00:11,070
، مهم است که ابتدا تفاوتهای بین مستندسازی و کامنت گذاشتن را تشخیص دهید.
6
00:00:11,070 –> 00:00:12,509
7
00:00:12,509 –> 00:00:14,400
8
00:00:14,400 –> 00:00:16,950
9
00:00:16,950 –> 00:00:19,320
10
00:00:19,320 –> 00:00:21,330
آنهایی که بیشتر کد را
11
00:00:21,330 –> 00:00:22,970
توسعه داده و نگه می
12
00:00:22,970 –> 00:00:25,650
دارند همراه با نظرات کد به خوبی نوشته شده
13
00:00:25,650 –> 00:00:27,180
به خواننده کمک می
14
00:00:27,180 –> 00:00:28,920
کنند تا کد و همچنین
15
00:00:28,920 –> 00:00:31,890
هدف مورد نظر را بهتر درک کند و کد طراحی به شما می گوید
16
00:00:31,890 –> 00:00:34,949
چگونه اما نظرات به شما می گوید که چرا جف
17
00:00:34,949 –> 00:00:38,670
اتوود با نام مستعار کدهای مستند ترسناک
18
00:00:38,670 –> 00:00:40,110
کدنویسی را توصیف می کند.
19
00:00:40,110 –> 00:00:42,989
عملکرد استفاده از آن برای کاربران شما ممکن است
20
00:00:42,989 –> 00:00:44,879
به فرآیند توسعه کمک کند، با این حال
21
00:00:44,879 –> 00:00:46,980
مخاطبان اصلی مورد نظر
22
00:00:46,980 –> 00:00:50,010
کاربران بالقوه و بالفعل کد هستند، اکنون بیایید
23
00:00:50,010 –> 00:00:51,390
نگاهی بیندازیم که چه زمانی باید کد خود را نظر
24
00:00:51,390 –> 00:00:53,850
دهید و چگونه
25
00:00:53,850 –> 00:00:55,860
ایجاد نظر در پایتون انجام می شود. با
26
00:00:55,860 –> 00:00:57,420
یک ظاهر طراحی شده خط با علامت پوند یا
27
00:00:57,420 –> 00:00:58,950
هش بسته به چه چیزی شما بیشتر
28
00:00:58,950 –> 00:01:01,020
با آنها آشنا هستید، باید مختصر باشند
29
00:01:01,020 –> 00:01:04,500
و اکنون بیش از چند جمله
30
00:01:04,500 –> 00:01:07,229
این نمونه را روی صفحه بررسی کنید زیرا می بینید
31
00:01:07,229 –> 00:01:09,390
که یک نظر وجود دارد که می گوید یک نظر ساده
32
00:01:09,390 –> 00:01:11,010
قبل از یک عبارت چاپی ساده
33
00:01:11,010 –> 00:01:13,770
است، می توانید هش یا
34
00:01:13,770 –> 00:01:16,860
پوند را ببینید اگر شما فقط در اینجا خواهید دید و می توانید
35
00:01:16,860 –> 00:01:18,660
ببینید که رنگ آن متفاوت است و
36
00:01:18,660 –> 00:01:21,119
همچنین از نظر نحوی نشان می دهد که
37
00:01:21,119 –> 00:01:23,610
یک نظر است و نه یک تابع یا هر
38
00:01:23,610 –> 00:01:24,060
چیز دیگری
39
00:01:24,060 –> 00:01:27,149
اکنون مطابق با pep ate یا PEP
40
00:01:27,149 –> 00:01:29,550
ate که یک دستورالعمل استاندارد برای
41
00:01:29,550 –> 00:01:31,710
تنظیم نظرات کد پایتون است که
42
00:01:31,710 –> 00:01:33,420
نباید طولانی تر باشد. بیش از 72 کاراکتر و
43
00:01:33,420 –> 00:01:35,190
این باید درست باقی بماند، حتی اگر
44
00:01:35,190 –> 00:01:37,259
پروژه شما حداکثر طول خط
45
00:01:37,259 –> 00:01:39,030
را بیشتر از 80 کاراکتر توصیه شده تغییر دهد،
46
00:01:39,030 –> 00:01:42,390
اگر نظری طولانیتر از
47
00:01:42,390 –> 00:01:44,369
حد کاراکتر باشد، تقسیم آن به
48
00:01:44,369 –> 00:01:47,160
چند خط مناسب است اگر
49
00:01:47,160 –> 00:01:49,530
به اینجا نگاه کنید، میتوانید نظر را
50
00:01:49,530 –> 00:01:52,320
در دو خط مشاهده کنید که هر دو خط
51
00:01:52,320 –> 00:01:54,479
با کلید هش شروع میشوند، اگر میخواهید
52
00:01:54,479 –> 00:01:55,960
53
00:01:55,960 –> 00:01:59,050
اکنون نظر دهید چرا باید نظر
54
00:01:59,050 –> 00:02:00,850
دهید که کد شما چندین هدف را ارائه میکند.
55
00:02:00,850 –> 00:02:03,550
این موارد شامل برنامهریزی و بررسی
56
00:02:03,550 –> 00:02:05,680
بخشهای جدید کد میشود، زیرا ممکن است ابتدا
57
00:02:05,680 –> 00:02:07,540
استفاده از نظرات به عنوان راهی برای
58
00:02:07,540 –> 00:02:09,580
تشریح هدف و عملکرد آن
59
00:02:09,580 –> 00:02:12,040
بخش از کد مناسب باشد، فقط مطمئن شوید که
60
00:02:12,040 –> 00:02:14,110
پس از تکمیل بخش، نظر را حذف میکنید.
61
00:02:14,110 –> 00:02:17,250
در اینجا
62
00:02:17,250 –> 00:02:20,160
توضیحات کد توضیح دهنده هدف
63
00:02:20,160 –> 00:02:23,520
بخش های خاصی از کد دوباره
64
00:02:23,520 –> 00:02:25,950
یک مثال را فقط در اینجا ببینید، بنابراین
65
00:02:25,950 –> 00:02:28,230
اگر
66
00:02:28,230 –> 00:02:30,000
ناموفق از کاربر برای تنظیمات جدید درخواست
67
00:02:30,000 –> 00:02:34,670
کرد،
68
00:02:34,800 –> 00:02:37,290
توضیحات مختصر با استفاده از نظرات در
69
00:02:37,290 –> 00:02:38,970
این مورد برای توضیح نحوه عملکرد الگوریتم مفید است.
70
00:02:38,970 –> 00:02:41,190
یا اینکه چگونه
71
00:02:41,190 –> 00:02:43,980
در کد پیادهسازی شده است و توضیح میدهد که چرا یک
72
00:02:43,980 –> 00:02:46,140
رویکرد خاص بر روی یک