اخیراً در مورد روند مستندسازی و آموزش کدم به دیگران بسیار فکر کرده‌ام. به عنوان یک توسعه دهنده جوان 😅، من همیشه به دنبال راه هایی برای بهبود هستم. یکی از چیزهایی که در کار گذشته خود متوجه شده ام این است که تفسیر کد اغلب بهینه نبود. بگذارید به شما بگویم، بازگشت به پروژه‌ای که تقریباً دو سال است به آن دست نزده‌ام و یافتن تنها 10 نظر در کل پروژه جهنمی است. بنابراین، امیدوارم بتوانید از این مقاله و افکار من چیزی بیاموزید.
همچنین، حتماً مراقب مقاله آینده من باشید که به طور خاص روی آن تمرکز دارد هنر نظر دادن کد در .خالص. شما نمی خواهید آن را از دست بدهید! حتماً من را دنبال کنید تا از آخرین دیدگاه ها و مقالات من به روز بمانید.
نظرات در کد مانند یادداشت گذاشتن برای خود آینده شما و دیگرانی است که ممکن است روی کد کار کنند. چرا این قطعه کد را به روش خاصی نوشتم؟ چرا رویکرد جایگزین را انتخاب نکردم؟ کد، طبیعتاً به شما می گوید “چگونه”، نظرات در حالت ایده آل باید به شما “چرا” را بگویند. این فلسفه ای است که در طول سال ها به آن قدردانی کرده ام.
بنابراین بر اساس تفکر و تجربه گذشته ام، فکر می کنم اقدامات زیر بسیار منطقی هستند. حداقل برای من 😅
در مورد چرا، نه در مورد چیست نظر دهید: من تلاش می‌کنم کدی بنویسم که از نظر کاری که انجام می‌دهد، خود توضیحی باشد. نظرات من سپس به ارائه زمینه، توضیح تصمیمات من، یا برجسته کردن هر جنبه غیر آشکار کد اختصاص داده می شود.
نظرات را مرتبط نگه دارید: یکی از چیزهایی که من به سختی یاد گرفتم این است که نظرات قدیمی یا نادرست می توانند بدتر از عدم اظهار نظر باشند. بنابراین، هر بار که کد خود را به روز می کنم، به این نکته توجه می کنم که نظرات مربوطه را نیز به روز کنم.
از نظرات اضافی خودداری کنید: هر چقدر هم که اظهار نظر درباره همه چیز وسوسه انگیز باشد، از اظهار نظر در مورد بدیهی اجتناب می کنم. من معتقدم که اگر کد من تمیز و واضح باشد، باید تا حد زیادی خودش صحبت کند.
از نظرات اسناد XML استفاده کنید: به نظر من نظرات مستندات XML ابزاری عالی برای ارائه اطلاعات در مورد کلاس‌ها، روش‌ها، ویژگی‌های کد من است. من و تیمم
کد اظهار نظر شده: در اوایل، کدهای کامنت‌شده را در فایل‌های منبع خود می‌گذاشتم، اما به زودی متوجه شدم که درهم ریختگی غیرضروری ایجاد می‌کند. من برای به خاطر سپردن کدهای قدیمی به کنترل منبع تکیه کردم.
در پایان، من می گویم که کامنت گذاری کد واقعاً یک شکل هنری است. هنگامی که به درستی انجام شود، می‌تواند به میزان قابل توجهی درک پایگاه کد شما را افزایش دهد و بهره‌وری را هم برای خود و هم برای دیگران بهبود بخشد. و همیشه به یاد داشته باشید که نظرات شما بازتابی از روند فکری شماست، بنابراین سعی کنید تا حد امکان آنها را شفاف کنید.
من مطمئن هستم که بینش های بیشتری از جامعه گسترده توسعه دهندگان وجود دارد. بنابراین، من همه شما را تشویق می کنم که افکار و اقدامات خود را که در طول سال ها استفاده کرده اید در بخش نظرات به اشتراک بگذارید. از هم یاد بگیریم!
از کدنویسی لذت ببرید 😄
