نوشتن توضیحات (comments)، در MySQL
توضیحات (comments)، متنی است که ما در بین کدهای اصلی می نویسیم و تنها برای شرح بخشی از کدها به کار خواهد رفت و هیچ اثری در اجرای کدها نخواهد داشت. در واقع، هنگامی که ما کدهایی را می نویسیم، ممکن است بخواهیم شرح عملکرد آنها یا تذکرهایی در مورد آنها را در کنارشان داشته باشیم تا چنانچه در آینده، دوباره خواستیم که کدها را بخوانیم، آن شرح ها و تذکرات، به ما برای درک بهتر کدها کمک کنند.
معمولا ما کدهای MySQL را به دو صورت اجرا می کنیم. یکی اینکه ممکن است query (کد MySQL - در واقع کد SQL) را مستقیما در محیطی اجرا کنیم و حالت دیگر اینکه با زبان های واسطه (مثل PHP)، تمامی query ها را اجرا نماییم. بنابراین در حالت دوم، از نوشتن توضیحات در زبان های واسطه مثل PHP نیز می توان استفاده کرد (مثلا نوشتن توضیحات مربوط به زبان PHP در خارج از query و در میان کدهای PHP)، اما آنچه در این مبحث مد نظر ما است، نوشتن توضیحات (comments) در خود query (کد MySQL) می باشد (حال این query شامل توضیحات می تواند مستقیما اجرا شود و یا اینکه توسط یک زبان واسطه مثل PHP).
در MySQL ، توضیحات (comments) را می توانیم به دو صورت توضیحات تک خطی و توضیحات چند خطی (multiline) بنویسیم.
در MySQL ، یک نوع توضیحات قابل اجرا (Executable comments) نیز داریم که آن را در کلید شماره 26037 شرح داده ایم.
نوشتن توضیحات (comments) تک خطی، در MySQL :
در توضیحات (comments) تک خطی، متن مربوط به توضیحات، تنها در یک خط نوشته می شود. علامت های -- و یا علامت # برای نوشتن توضیحات (comments) تک خطی در MySQL به کار می روند (باید متن توضیحات را بعد از این علامت ها بنویسیم).
در query بالا، عبارت -- This is a comment یک توضیح تک خطی است و اجرا نخواهد شد.
در query بالا، عبارت # This is a comment یک توضیح تک خطی است و اجرا نخواهد شد.
نوشتن توضیحات (comments) چند خطی (multiline)، در MySQL :
چنانچه بخواهیم که توضیحات مورد نظرمان را در چند خط پشت سرهم بنویسیم، می توانیم از توضیحات (comments) چند خطی (multiline) استفاده کنیم (به جای توضیحات تک خطی). علامت های */ و /* برای نوشتن توضیحات (comments) چند خطی (multiline) به کار می روند. به این صورت که باید در ابتدای توضیحات، علامت های */ را بنویسیم و در انتهای توضیحات نیز علامت های /* نوشته می شوند.
در query بالا، عبارت زیر یک توضیح چند خطی (multiline) است و اجرا نخواهد شد :
