در این قسمت از دوره آموزش رایگان برنامه نویسی VBA به یکی از مفاهیم اساسی در کدنویسی VBA که عموما کمتر به آن پرداخته میشود خواهیم پرداخت؛ اضافه کردن کامنت(Comment) در VBA

منظور از کامنت همانطور که از نام آن مشخص است متنی است که نشان میشود کدهای VBA نوشته شده با جه هدفی ایجاد شده اند. کامنت ها در کدهای VBA نوشته شده هیچ خللی ایجاد نمیکنند، زیرا در زمان اجرای کد، VBA کامنت های ایجاد شده را نادیده می گیرد.

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

بدون استفاده از کامنت گذاری در برنامه نویسی VBA می بایست از ابتدا تا انتها، یکبار مفهوم کدهای نوشته شده را بازبینی و بررسی کنید، کاری که ابدا معقولانه به نظر نمی رسد. البته ممکن است حین کدنویسی فکر کنید کامنت گذاری کاری بیهوده است ولی به شما اطمینان میدهم در آینده به خاطر این مستندسازی از خود سپاسگذار خواهید بود.

نحوه کامنت گذاری در برنامه نویسی VBA

کامنت ها همیشه با یک آپاستروف(‘) شروع میشوند.

کامنت ها میتوانند یک خط کامل از کد باشند:

sub HelloNewWorlds()
'This is a whole comment line - this code opens a message box
MsgBox "Hello new world!"
>End Sub

یا اینکه خود، قسمتی از یک خط کد دیگر باشند:

sub HelloNewWorld()
MsgBox "Hello new world!"  'This is a partial comment line - this code opens a message box
End Sub

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

اگر میخواهید چندین کامنت پشت سر هم داشته باشید می بایست در ابتدای هر خط یک علامت آپاستروف(‘) قرار دهید:

sub HelloNewWorld()
'Comment line #1
'Comment line #2
'Comment line #3
MsgBox "Hello new world!"
 End Sub

نکات مهم در بهبود کامنت گذاری

• همیشه در حین کدنویسی کامنت های خود را وارد کنید.
• برای توضیح یک رویه در بالای آن( نه در پایین) توضیحات مورد نظر را کامنت کنید.
• زمانی که رویه های پیچیده ای را کدنویسی میکنید، از کامنت های جداگانه برای توضیح قسمت های مختلف آن استفاده کنید.
• برای توضیح هدف متغیرهای ایجاد شده از کامنت استفاده کنید.
• زمانی که هدف از یک سطر کد به خوبی روشن نیست حتما از کامنت استفاده کنید.
• زمانی که از روش های غیر استاندارد استفاده میکنید حتما دلیل این کار را با استفاده از کامنت توضیح دهید

استفاده از کامنت در زمان رفع نقض کدهای VBA

موقعیت های وجود دارد که کدهای VBA به همان صورتی که انتظار دارید، عمل نمیکنند. در این صورت می بایست با استفاده از فرایندهای debug که در قسمت های آینده مفصل به آن خواهیم پرداخت، دلیل این موضوع را پیدا کنید و با رفع تقص، مسئله را حل کنید. در این فرایند، ممکن است زمانی که تلاش میکنید مشکل را رفع کنید، تغییراتی ایجاد کنید که کار را بسیار بدتر میکند و آرزو کنید که ای کاش به عقب برمیگشتید. به همین دلیل من پیشنهاد میکنم در زمان ایجاد تغییر برای debug، همیشه کدها را کپی کنید و با استفاده از آپاستروف تبدیل به کامنت کنید و سپس تغییرات مورد نظر را در کدهای VBA ایجاد کنید. به این صورت هر موقع خواستید به عقب برگردید، کدهای VBA اصلی به راحتی در اختیارتان قرار دارد. زمانی که مشکل کدها رفع شد میتوانید کامنت های حاوی کدهای قدیمی را حذف کنید.

برای مطالعه بیشتر در زمینه برنامه نویسی VBA به صفحه “دوره رایگان آموزش برنامه نویسی VBA” مراجعه کنید.