کامنت نویسی به زبان برنامه نویسی

با سلام خدمت همراهان همیشگی وب سایت پرنیان طرح

هنگام برنامه نویسی در کامپیوتر، گاهی اوقات لازم است کامنت هایی بنویسید ؛ تا سایر توسعه دهندگان بتوانند کد شما را با سهولت مرور کنند .

حال اگر این برنامه ، یک پروژه منبع باز یا یک پروژه اختصاصی باشد ، نوشتن کامنت لازم است تا با همکاران و توسعه دهندگانی که در  آینده ممکن است به شما ملحق شوند، هماهنگی لازم انجام شود.

بدون کامنت نویسی ، کد نوشته شده غیرقابل فهمیدن و نگهداری در آینده خواهد بود.

قدم اول

هدف از کامنت نویسی برای یک برنامه را درک کنید.

• در اینجا خوانا بودن متن، یک نکته کلیدی است. در اینصورت ،وقتی به یک کامنت نگاه می کنید باید بدانید که این یک نوشته، یک کامنت و توضیح است ، نه یک کد.
• از طرفی، این کامنت و توضیح بایدقابل درک باشد، نه تنها برای شما، بلکه برای هر کسی که ممکن است کد شما را مطالعه کند.

قدم دوم

به یک روش کوتاه و ساده برای فهماندن نظر خود فکر کنید. 

• نیازی نیست که کامنت های شما یک اثر هنری باشند. آنها باید مختصر ، مرتب و منظم باشند.
• با این وجود ، نگران این نباشید که کامنت ها و توضیحاتتان چندخطی شوند. مهمترین نکته این است که اطلاعات به درستی به خواننده کامنت ها منتقل شوند.

قدم سوم

با استفاده از ترکیب و دستور نوشتاری مناسب داده شده توسط زبان برنامه نویسی ، کامنت را بنویسید.

قواعد کامنت نویسی را که برای هر زبان برنامه نویسی اختصاصی می باشند، رعایت کنید.

قدم چهارم

از خود بپرسید که آیا کامنتی که شما نوشتید به اندازه کافی کامل است.

یک کامنت باید بتواند به مخاطبی که آن را مطالعه بگوید که آن بخش از برنامه، بدون نیاز به تدوین و اجرا، واقعا چه کاری انجام می دهد.

باید بررسی کنید که آیا، کامنت شما این توضیح را می دهد؟

آیا تمام جزئیات لازم را به مخاطب منتقل می کند؟

کامنت نویسی در برنامه نویسی