godoc - ອອນລາຍໃນຄລາວ

ໂຄງການ:

NAME

godoc - ສະກັດແລະສ້າງເອກະສານສໍາລັບໂຄງການ Go

ສະຫຼຸບສັງລວມ

godoc [ທຸງ] ຄໍາ​ສັ່ງ [ ຊື່ ... ]

ລາຍລະອຽດ

Godoc ສະກັດແລະສ້າງເອກະສານສໍາລັບໂຄງການ Go.

ມັນມີສອງໂຫມດ.

ໂດຍບໍ່ມີທຸງ -http, ມັນດໍາເນີນການໃນຮູບແບບຄໍາສັ່ງແລະພິມເອກະສານຂໍ້ຄວາມທໍາມະດາ
ກັບຜົນຜະລິດມາດຕະຖານແລະການອອກ. ຖ້າທັງຊຸດຫ້ອງສະຫມຸດແລະຄໍາສັ່ງທີ່ມີຊື່ດຽວກັນ
ມີຢູ່, ການນໍາໃຊ້ຄໍານໍາຫນ້າ cmd / ຈະບັງຄັບໃຫ້ເອກະສານກ່ຽວກັບຄໍາສັ່ງແທນທີ່ຈະເປັນ
ຊຸດຫ້ອງສະຫມຸດ. ຖ້າທຸງ -src ຖືກລະບຸ, godoc ຈະພິມສ່ວນຕິດຕໍ່ທີ່ສົ່ງອອກຂອງ a
ແພັກເກດໃນຮູບແບບ Go source, ຫຼືການຈັດຕັ້ງປະຕິບັດຫົວໜ່ວຍພາສາທີ່ສົ່ງອອກສະເພາະ:

godoc fmt # ເອກະສານສໍາລັບຊຸດ fmt
godoc fmt Printf # ເອກະສານສໍາລັບ fmt.Printf
godoc cmd/go # ບັງຄັບເອກະສານສໍາລັບຄໍາສັ່ງ go
godoc -src fmt # fmt ການໂຕ້ຕອບຊຸດໃນຮູບແບບ Go
godoc -src fmt Printf # ການປະຕິບັດຂອງ fmt.Printf

ໃນ​ຮູບ​ແບບ​ບັນ​ດາ​ຄໍາ​ສັ່ງ​, ທຸງ -q ເຮັດ​ໃຫ້​ການ​ສອບ​ຖາມ​ການ​ຊອກ​ຫາ​ຕໍ່​ກັບ godoc ແລ່ນ​ເປັນ a
ເຊີບເວີ. ຖ້າບໍ່ມີການລະບຸທີ່ຢູ່ເຊີບເວີຢ່າງຈະແຈ້ງດ້ວຍທຸງ -server, godoc ທໍາອິດ
ພະຍາຍາມ localhost:6060 ແລະຫຼັງຈາກນັ້ນ http://golang.org.

godoc -q ຜູ້ອ່ານ
godoc -q math.Sin
godoc -server=:6060 -q sin

ດ້ວຍທຸງ -http, ມັນດໍາເນີນການເປັນເຄື່ອງແມ່ຂ່າຍເວັບໄຊຕ໌ແລະນໍາສະເຫນີເອກະສານເປັນຫນ້າເວັບ.

godoc -http=:6060

ໂດຍຄ່າເລີ່ມຕົ້ນ, godoc ເບິ່ງແພັກເກັດທີ່ມັນພົບຜ່ານ $GOROOT ແລະ $GOPATH (ຖ້າຕັ້ງ).
ໄດເລກະທໍລີເພີ່ມເຕີມອາດຈະຖືກລະບຸໂດຍຜ່ານທຸງ -path ທີ່ຍອມຮັບບັນຊີລາຍຊື່ຂອງຈໍ້າສອງເມັດ.
ເສັ້ນທາງແຍກ; ເສັ້ນທາງທີ່ບໍ່ໄດ້ຮາກຖານແມ່ນກ່ຽວຂ້ອງກັບໄດເລກະທໍລີທີ່ເຮັດວຽກໃນປະຈຸບັນ. ແຕ່ລະເສັ້ນທາງ
ຖືກພິຈາລະນາເປັນຮາກເພີ່ມເຕີມສໍາລັບການຫຸ້ມຫໍ່ຕາມລໍາດັບຂອງຮູບລັກສະນະ. ສຸດ​ທ້າຍ
(absolute) ອົງປະກອບເສັ້ນທາງແມ່ນຄໍານໍາຫນ້າສໍາລັບເສັ້ນທາງຊຸດ. ສໍາລັບຕົວຢ່າງ, ໃຫ້ທຸງ
ມູນຄ່າ:

path=".:/home/bar:/public"

ສໍາລັບ godoc ທີ່ເລີ່ມຕົ້ນໃນ /home/user/godoc, ເສັ້ນທາງຢ່າງແທ້ຈິງແມ່ນຖືກສ້າງແຜນທີ່ເປັນເສັ້ນທາງແພັກເກດ.
ຕໍ່ໄປນີ້:

/home/user/godoc/x -> godoc/x
/home/bar/x -> bar/x
/public/x -> public/x

ເມື່ອ godoc ແລ່ນເປັນເຄື່ອງແມ່ຂ່າຍເວັບແລະ -index ຖືກກໍານົດ, ດັດສະນີຄົ້ນຫາຖືກຮັກສາໄວ້. ດັດຊະນີ
ຖືກສ້າງຂື້ນໃນຕອນເລີ່ມຕົ້ນ.

ດັດຊະນີມີທັງຕົວລະບຸ ແລະຂໍ້ມູນການຊອກຫາຂໍ້ຄວາມເຕັມ (ສາມາດຄົ້ນຫາໄດ້ຜ່ານ
ການສະແດງອອກເປັນປົກກະຕິ). ຈໍານວນສູງສຸດຂອງຜົນການຄົ້ນຫາຂໍ້ຄວາມເຕັມທີ່ສະແດງໃຫ້ເຫັນສາມາດຖືກກໍານົດດ້ວຍ
ທຸງ -maxresults; ຖ້າຕັ້ງເປັນ 0, ບໍ່ມີຜົນໄດ້ຮັບຂໍ້ຄວາມເຕັມທີ່ສະແດງ, ແລະມີພຽງແຕ່ຕົວລະບຸ
index ແຕ່ບໍ່ມີດັດສະນີຄົ້ນຫາຂໍ້ຄວາມເຕັມທີ່ຖືກສ້າງຂຶ້ນ.

ຮູບແບບການນໍາສະເຫນີຂອງຫນ້າເວັບທີ່ໃຫ້ບໍລິການໂດຍ godoc ສາມາດຄວບຄຸມດ້ວຍ URL "m".
ພາລາມິເຕີ; ມັນຍອມຮັບບັນຊີລາຍຊື່ທີ່ຂັ້ນດ້ວຍເຄື່ອງໝາຍຈຸດຂອງຊື່ທຸງເປັນຄ່າ:

ທັງຫມົດ ສະ​ແດງ​ເອ​ກະ​ສານ​ສໍາ​ລັບ​ການ​ປະ​ກາດ​ທັງ​ຫມົດ​, ບໍ່​ພຽງ​ແຕ່​ການ​ສົ່ງ​ອອກ​

ວິທີການ
ສະ​ແດງ​ໃຫ້​ເຫັນ​ວິ​ທີ​ການ​ຝັງ​ທັງ​ຫມົດ​, ບໍ່​ພຽງ​ແຕ່​ຂອງ​ທີ່​ບໍ່​ມີ​ຊື່​ທີ່​ບໍ່​ໄດ້​ສົ່ງ​ອອກ​

src ສະແດງລະຫັດແຫຼ່ງຕົ້ນສະບັບແທນທີ່ຈະເປັນເອກະສານທີ່ສະກັດອອກ

ຂໍ້ຄວາມ ນໍາສະເຫນີຫນ້າໃນຮູບແບບຂໍ້ຄວາມ (ເສັ້ນຄໍາສັ່ງ) ແທນທີ່ຈະເປັນ HTML

ແປ ປະຈຸບັນລາຍຊື່ໄດເລກະທໍລີແບບຮາບພຽງ (ບໍ່ຫຍໍ້ໜ້າ) ໂດຍໃຊ້ເສັ້ນທາງເຕັມ

ຕົວ​ຢ່າງ, http://golang.org/pkg/math/big/?m=all,ຂໍ້ຄວາມສະແດງເອກະສານສຳລັບທັງໝົດ
(ບໍ່ແມ່ນພຽງແຕ່ການສົ່ງອອກ) ການປະກາດຂອງຊຸດໃຫຍ່, ໃນຮູບແບບຂໍ້ຄວາມ (ຕາມທີ່ມັນຈະປາກົດ
ເມື່ອໃຊ້ godoc ຈາກບັນທັດຄໍາສັ່ງ: "godoc -src math/big .*").

ໂດຍຄ່າເລີ່ມຕົ້ນ, godoc ໃຫ້ບໍລິການໄຟລ໌ຈາກລະບົບໄຟລ໌ຂອງ OS ທີ່ຕິດພັນ. ແທນທີ່ຈະ, a .zip
ໄຟລ໌ອາດຈະຖືກສະຫນອງໃຫ້ໂດຍຜ່ານທຸງ -zip, ເຊິ່ງປະກອບດ້ວຍລະບົບໄຟລ໌ທີ່ຈະໃຫ້ບໍລິການ. ໄຟລ໌
ເສັ້ນທາງທີ່ເກັບໄວ້ໃນໄຟລ໌ .zip ຈະຕ້ອງໃຊ້ slash ('/') ເປັນຕົວແຍກເສັ້ນທາງ; ແລະພວກເຂົາຕ້ອງເປັນ
unrooted. $GOROOT (ຫຼື -goroot) ຕ້ອງຖືກຕັ້ງເປັນເສັ້ນທາງໄດເຣັກທໍຣີໄຟລ໌ .zip ທີ່ມີ
ໄປ root directory. ຕົວຢ່າງ, ສໍາລັບໄຟລ໌ .zip ທີ່ສ້າງຂຶ້ນໂດຍຄໍາສັ່ງ:

zip go.zip $HOME/go

ຫນຶ່ງອາດຈະດໍາເນີນການ godoc ດັ່ງຕໍ່ໄປນີ້:

godoc -http=:6060 -zip=go.zip -goroot=$HOME/go

ເບິ່ງ "Godoc: documenting Go code" ສໍາລັບວິທີການຂຽນຄໍາຄິດຄໍາເຫັນທີ່ດີສໍາລັບ godoc:
http://golang.org/doc/articles/godoc_documenting_go_code.html

OPTIONS

-v ໂໝດ verbose

-q arguments ແມ່ນພິຈາລະນາຄໍາຖາມຄົ້ນຫາ: ຄໍາຖາມທາງກົດຫມາຍແມ່ນຕົວລະບຸດຽວ (ເຊັ່ນ
ເປັນ ToLower) ຫຼືຕົວລະບຸທີ່ມີຄຸນສົມບັດ (ເຊັ່ນ: math.Sin).

-src ແຫຼ່ງພິມ (ສົ່ງອອກ) ໃນຮູບແບບຄໍາສັ່ງ

-tabwidth=4
ຄວາມກວ້າງຂອງແຖບໃນຫົວໜ່ວຍຂອງຊ່ອງ

-timestamps=ຈິງ
ສະແດງເວລາທີ່ມີລາຍຊື່ໄດເລກະທໍລີ

-ດັດຊະນີ ເປີດໃຊ້ຕົວລະບຸແລະດັດສະນີຄົ້ນຫາຂໍ້ຄວາມເຕັມ (ບໍ່ມີປ່ອງຊອກຫາສະແດງຖ້າ -index ແມ່ນ
ບໍ່ໄດ້ຕັ້ງ)

-index_files=""
glob ຮູບແບບການລະບຸໄຟລ໌ດັດສະນີ; ຖ້າບໍ່ຫວ່າງ, ດັດຊະນີແມ່ນອ່ານຈາກເຫຼົ່ານີ້
ໄຟລ໌ຢູ່ໃນລໍາດັບ

-index_throttle=0.75
index throttle value; ຄ່າຂອງ 0 ຫມາຍຄວາມວ່າບໍ່ມີການຈັດສັນເວລາໃຫ້ກັບຕົວດັດສະນີ (the
indexer ຈະບໍ່ສິ້ນສຸດ), ມູນຄ່າຂອງ 1.0 ຫມາຍຄວາມວ່າການສ້າງດັດສະນີແມ່ນແລ່ນຢູ່ທີ່
throttle ເຕັມ (gooutines ອື່ນໆອາດຈະບໍ່ໄດ້ໃຊ້ເວລາໃນຂະນະທີ່ດັດຊະນີແມ່ນສ້າງຂຶ້ນ)

-write_index=false
ຂຽນດັດສະນີໃສ່ໄຟລ໌; ຊື່ໄຟລ໌ຕ້ອງຖືກລະບຸດ້ວຍ -index_files

-ຜົນໄດ້ຮັບສູງສຸດ=10000
ຈໍາ​ນວນ​ສູງ​ສຸດ​ຂອງ​ຜົນ​ໄດ້​ຮັບ​ການ​ຊອກ​ຫາ​ຂໍ້​ຄວາມ​ເຕັມ​ທີ່​ສະ​ແດງ​ໃຫ້​ເຫັນ (ບໍ່​ມີ​ດັດ​ຊະ​ນີ​ຂໍ້​ຄວາມ​ເຕັມ​ທີ່​ຖືກ​ສ້າງ​ຂຶ້ນ​ຖ້າ​ຫາກ​ວ່າ​
ຜົນໄດ້ຮັບສູງສຸດ <= 0)

-path=""
ໄດເຣັກທໍຣີແພັກເກັດເພີ່ມເຕີມ (ທີ່ຂັ້ນດ້ວຍຈໍ້າສອງເມັດ)

-html ພິມ HTML ໃນຮູບແບບຄໍາສັ່ງ

-goroot=$GOROOT
ໄປ root directory

-http=addr
ທີ່ຢູ່ບໍລິການ HTTP (ເຊັ່ນ: '127.0.0.1:6060' ຫຼືພຽງແຕ່ ':6060')

-server=addr
ທີ່ຢູ່ webserver ສໍາລັບການຊອກຫາເສັ້ນຄໍາສັ່ງ

-templates = ""
ໄດເລກະທໍລີທີ່ບັນຈຸໄຟລ໌ແມ່ແບບສະຫຼັບ; ຖ້າຕັ້ງ, ໄດເລກະທໍລີອາດຈະສະຫນອງ
ໄຟລ໌ແມ່ແບບທາງເລືອກສໍາລັບໄຟລ໌ໃນ $GOROOT/lib/godoc

-url=ເສັ້ນທາງ
ພິມເປັນມາດຕະຖານຜົນຜະລິດຂໍ້ມູນທີ່ຈະຖືກຮັບໃຊ້ໂດຍການຮ້ອງຂໍ HTTP ສໍາລັບເສັ້ນທາງ

-zip=""
zip ສະໜອງລະບົບໄຟລ໌ເພື່ອຮັບໃຊ້; ປິດການໃຊ້ງານຖ້າຫວ່າງເປົ່າ

ໃຊ້ godoc ອອນໄລນ໌ໂດຍໃຊ້ບໍລິການ onworks.net