آموزش برنامه نویسی

توضیحات

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

  1 package main
  2 
  3 import "fmt"
  4 
  5 func main(){
  6    //This line will print the message hello world
  7    fmt.Println("Hello World!")
  8 }

در کد بالا، خط 6 کد بالا یک توضیح درباره خط 7 است که به کاربر اعلام می کند که وظیفه خط 7 چیست ؟ با اجرای کد بالا فقط جمله Hello World چاپ شده و خط اول در خروجی نمایش داده نمی شود چون کامپایلر توضیحات را نادیده می گیرد. همانطور که مشاهده می کنید برای درج توضیحات در Go از علامت // استفاده می شود. اگر توضیح درباره یک کد به بیش از یک خط نیاز باشد از توضیحات چند خطی استفاده می‌شود. توضیحات چند خطی با */ شروع و با /* پایان می‌یابند. هر نوشته‌ای که بین این دو علامت قرار بگیرد جز توضیحات محسوب می‌شود.

package main

import "fmt"

func main(){
   /*This line will print 
   the message hello world*/
   fmt.Println("Hello World!")
}