هنگام برنامه نویسی بر روی رایانه ، گاهی اوقات لازم است یادداشت ها یا نظرات خود را بگذارید تا سایر توسعه دهندگان به راحتی کد شما را مرور کنند. چه پروژه منبع باز باشد و چه پروژه اختصاصی ، برای هماهنگی با توسعه دهندگان مشترک و توسعه دهندگان احتمالی آینده نیز به نظرات نیاز است. بدون نظر ، کد به سادگی قابل نگهداری نخواهد بود.
مراحل
مرحله 1. هدف از اظهار نظر در مورد یک برنامه کامپیوتری را درک کنید
- در اینجا خواندن مهمترین چیز است. وقتی به نظری نگاه می کنید باید بدانید که این یک نظر است و یک خط کد نیست.
- این نظر همچنین باید نه تنها برای شما ، بلکه برای هرکسی که ممکن است کد منبع برنامه رایانه شما را بخواند مفید باشد.
مرحله 2. به یک راه ساده و کوتاه فکر کنید تا نقطه نظر خود را رد کنید
لازم نیست نظرات یک اثر هنری باشد. آنها باید مختصر ، مرتب و مستقیم به موضوع برسند.
با این حال ، این امر نباید از استفاده از چند خط برای اظهار نظر دلسرد شود. نکته این است که اطلاعات باید به خواننده برسد
مرحله 3. نظر را با استفاده از نحو مناسب که توسط زبان برنامه نویسی ارائه شده است بنویسید
مرحله 4. از خود بپرسید که آیا کامنتی که نوشته اید به اندازه کافی دقیق است؟
یک نظر باید بتواند به کسی که به کد منبع نگاه می کند بگوید که آن قسمت از برنامه در واقع بدون نیاز به کامپایل و اجرای آن چه می کند. آیا نظر شما این کار را انجام می دهد؟ آیا تمام جزئیات را منتقل می کند؟