به من نگو چگونه، بگو چرا!
آیا واضح است که این مربوط به نظرات است؟ اگر نه، آیا بهتر نیست عنوان “نظرات: به من نگو چگونه، بگو چرا!”
این مشکلی است که همه جا شاهد آن هستیم. نظراتی وجود دارد که بدون هیچ زمینه ای معنایی ندارد. سایرین باید کل کد (یا مقاله) را بخوانید تا معنی آن را بفهمید و حتی در این صورت ممکن است گمراه کننده یا قدیمی باشد.
این احتمالاً باید در بیشتر موارد اعمال شود، اما شما واقعاً یک کد واضح و تمیز می خواهید که هر کسی بتواند آن را بخواند و بفهمد که چه اتفاقی می افتد.
مگر اینکه واقعاً به هر دلیلی به کد کمتر خوانا و پیچیدهتر نیاز داشته باشید (معمولاً به دلیل عملکرد). در این مورد، لطفاً در مورد اینکه چه اتفاقی می افتد و چگونه است، نظر دهید. اما همچنین انجام…
چرا!
چرا از کدهای کمتر خوانا استفاده می کنید؟
چرا نباید ترتیب چیزی را تغییر دهم؟
چرا این اینجاست؟
چرا از این به جای XYZ استفاده شد؟
بسته به کاری که انجام میدهید، سطح شما و همکارانتان، چیزی معمولی برای یکی میتواند علم موشک برای دیگری باشد. موضوع این نیست.
اگر ماه بعد باید دوباره کد را مرور کنید، باید بدانید که کد با خواندن آن چه می کند. موضوع این است: چرا اینجاست؟
برخی از قطعات می تواند خود توضیحی مانند transformXtoY
اما چرا و کجا باید این کار را انجام دهم؟
همچنین نمیگویم «چرا» را در همه جا قرار دهید، اما اگر دوباره کد را مرور کنید و زمانی را صرف کشف چیزی کنید، یا اگر حتی پس از بازآفرینی آن، شخصی همیشه در مورد چیزی گیج شده است… پس بله، یک «چرا» اضافه کنید.
نه تنها این، درخواست های کششی منبع خوبی برای یافتن برخی از مکان هایی است که نیاز به اظهار نظر در مورد “چرا” دارند.
در روابط عمومی شخصی پرسید که چرا کاری کردی؟
فقط به آنها نگو! نه تنها این، آن را خارج از روابط عمومی انجام ندهید و آن را یک روز بنامید.
کد را اصلاح کنید، نظر چرایی وجود آن را اضافه کنید، و سپس هر بار که شخصی دوباره آن قطعه کد را مشاهده کرد، دلیل وجود آن در آنجا خواهد بود.