godoc - Bulutta Çevrimiçi

Program:

ADI

godoc - Go programları için belgeleri çıkarır ve oluşturur

SİNOPSİS

Godoc [bayrak] emretmek [ isim ... ]

TANIM

Godoc, Go programları için belgeleri çıkarır ve oluşturur.

İki modu vardır.

-http bayrağı olmadan komut satırı modunda çalışır ve düz metin belgeleri yazdırır
standart çıkış ve çıkışlara. Hem kitaplık paketi hem de aynı adda bir komut varsa
mevcutsa, cmd/ önekinin kullanılması komutta belgeleme yapılmasını zorunlu kılacaktır.
kütüphane paketi. -src bayrağı belirtilirse, godoc bir dosyanın dışa aktarılan arayüzünü yazdırır.
Go kaynak formundaki paket veya dışa aktarılan belirli bir dil varlığının uygulanması:

godoc fmt # fmt paketinin belgeleri
godoc fmt Printf # fmt.Printf için belgeler
godoc cmd/go # go komutu için dokümantasyonu zorla
godoc -src fmt # Go kaynak formundaki fmt paketi arayüzü
godoc -src fmt Printf # fmt.Printf'in uygulanması

Komut satırı modunda, -q bayrağı, bir Godoc olarak çalışan bir Godoc'a karşı arama sorgularını etkinleştirir.
Web sunucusu. -server bayrağıyla açık bir sunucu adresi belirtilmemişse, önce godoc
localhost:6060'ı dener ve sonra http://golang.org.

godoc -q Okuyucu
godoc -q matematik.Sin
godoc -sunucu=:6060 -q sin

-http bayrağı ile web sunucusu olarak çalışır ve dokümantasyonu web sayfası olarak sunar.

godoc -http=:6060

Godoc varsayılan olarak $GOROOT ve $GOPATH (eğer ayarlanmışsa) aracılığıyla bulduğu paketlere bakar.
İki nokta üst üste listesini kabul eden -path bayrağı aracılığıyla ek dizinler belirtilebilir.
ayrılmış yollar; köklenmemiş yollar geçerli çalışma dizinine göredir. Her yol
görünüm sırasına göre paketler için ek bir kök olarak kabul edilir. Son
(mutlak) yol öğesi, paket yolunun önekidir. Mesela bayrak verildiğinde
değeri:

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

/home/user/godoc'ta başlatılan bir godoc için mutlak yollar paket yollarına şu şekilde eşlenir:
aşağıdaki gibidir:

/home/user/godoc/x -> godoc/x
/home/bar/x -> çubuk/x
/genel/x -> genel/x

Godoc bir web sunucusu olarak çalıştığında ve -index ayarlandığında, bir arama dizini korunur. İçerik
başlangıçta oluşturulur.

Dizin hem tanımlayıcı hem de tam metin arama bilgilerini içerir (arama yoluyla aranabilir)
düzenli ifadeler). Gösterilen maksimum tam metin arama sonucu sayısı şu şekilde ayarlanabilir:
-maxresults bayrağı; 0 olarak ayarlanırsa tam metin sonuçları gösterilmez ve yalnızca bir tanımlayıcı gösterilir
dizin ancak tam metin arama dizini oluşturulmadı.

Godoc tarafından sunulan web sayfalarının sunum modu "m" URL'si ile kontrol edilebilir
parametre; değer olarak virgülle ayrılmış bayrak adları listesini kabul eder:

herşey yalnızca dışa aktarılanların değil, tüm bildirimlerin belgelerini göster

yöntemleri
yalnızca dışa aktarılmamış anonim alanlarınkileri değil, tüm gömülü yöntemleri göster

src çıkarılan belgeler yerine orijinal kaynak kodunu göster

metin sayfayı HTML yerine metin (komut satırı) biçiminde sunma

düz Tam yolları kullanarak düz (girintisiz) dizin listeleri sunma

Örneğin, http://golang.org/pkg/math/big/?m=all,metin tümünün belgelerini gösterir
(yalnızca dışa aktarılanlar değil) paket bildirimleri büyük, metin biçiminde (göründüğü gibi)
Godoc'u komut satırından kullanırken: "godoc -src math/big .*").

Varsayılan olarak godoc, dosyaları temel işletim sisteminin dosya sisteminden sunar. Bunun yerine bir .zip
dosya, sunulacak dosya sistemini içeren -zip bayrağı aracılığıyla sağlanabilir. Dosya
.zip dosyasında saklanan yollar, yol ayırıcı olarak eğik çizgi ('/') kullanmalıdır; ve onlar olmalı
köksüz. $GOROOT (veya -goroot), aşağıdakileri içeren .zip dosya dizini yoluna ayarlanmalıdır:
Kök dizine gidin. Örneğin, komut tarafından oluşturulan bir .zip dosyası için:

zip go.zip $HOME/go

godoc şu şekilde çalıştırılabilir:

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

Godoc için iyi yorumların nasıl yazılacağını öğrenmek için "Godoc: Go kodunu belgelemek" konusuna bakın:
http://golang.org/doc/articles/godoc_documenting_go_code.html

SEÇENEKLER

-v ayrıntılı mod

-q argümanlar arama sorguları olarak kabul edilir: yasal bir sorgu tek bir tanımlayıcıdır (örneğin
ToLower olarak) veya nitelikli bir tanımlayıcı (math.Sin gibi).

-kaynak kaynağı komut satırı modunda yazdır (dışa aktar)

-sekme genişliği=4
boşluk birimleri cinsinden sekmelerin genişliği

-zaman damgaları=doğru
dizin listeleriyle zaman damgalarını göster

dizin tanımlayıcıyı ve tam metin arama dizinini etkinleştirin (-index ise arama kutusu gösterilmez)
ayarlanmadı)

-index_files = ""
dizin dosyalarını belirten glob deseni; boş değilse indeks bunlardan okunur
dosyalar sıralı olarak

-index_throttle=0.75
indeks gaz kelebeği değeri; 0 değeri indeksleyiciye zaman ayrılmadığı anlamına gelir (
Dizin oluşturucu hiçbir zaman bitmeyecek), 1.0 değeri dizin oluşturma işleminin şu hızda çalıştığı anlamına gelir:
tam gaz (dizin oluşturulurken diğer goroutinler zaman alamayabilir)

-write_index=yanlış
bir dosyaya dizin yazın; dosya adı -index_files ile belirtilmelidir

-maxresults=10000
maksimum sayıda tam metin arama sonucu gösterilir (şayet tam metin dizini oluşturulmaz)
maksimumsonuçlar<= 0)

-yol = ""
ek paket dizinleri (iki nokta üst üste ayrılmış)

-html HTML'yi komut satırı modunda yazdır

-goroot=$GOROOT
Kök dizine git

-http=addr
HTTP hizmet adresi (örneğin, '127.0.0.1:6060' veya yalnızca ':6060')

-sunucu=addr
komut satırı aramaları için web sunucusu adresi

-şablonlar = ""
alternatif şablon dosyalarını içeren dizin; ayarlandıysa, dizin şunları sağlayabilir:
$GOROOT/lib/godoc içindeki dosyalar için alternatif şablon dosyaları

-url=yol
yol için bir HTTP isteği tarafından sunulacak verileri standart çıktıya yazdır

-zip = ""
dosya sisteminin hizmet vermesini sağlayan zip dosyası; boşsa devre dışı

Godoc'u onworks.net hizmetlerini kullanarak çevrimiçi kullanın