Pytania otagowane jako documentation

TEN TAG DOTYCZY WYŁĄCZNIE GENERATORÓW DOKUMENTÓW. Uwzględnij również tag języka i / lub SDE. NIE UŻYWAJ, aby prosić o łącza do dokumentacji lub narzędzi ani krytykować dokumentacji dostawcy.


20
#pragma mark w Swift?
W celu C mogę używać #pragma markdo zaznaczania części mojego kodu w nawigatorze symboli. Ponieważ jest to polecenie preprocesora języka C, nie jest ono dostępne w Swift. Czy w Swift jest na to jakieś rozwiązanie, czy też muszę używać brzydkich komentarzy?


30
Co to jest kod samodokumentujący i czy może zastąpić dobrze udokumentowany kod? [Zamknięte]
W obecnej formie to pytanie nie pasuje do naszego formatu pytań i odpowiedzi. Oczekujemy, że odpowiedzi poparte będą faktami, referencjami lub wiedzą specjalistyczną, ale to pytanie prawdopodobnie będzie wymagało debaty, argumentów, ankiet lub rozszerzonej dyskusji. Jeśli uważasz, że to pytanie można poprawić i ewentualnie ponownie otworzyć, odwiedź centrum pomocy w …

4
Jakie są nowe polecenia dokumentacji dostępne w Xcode 5? [Zamknięte]
Zamknięte. To pytanie nie jest zgodne z wytycznymi dotyczącymi przepełnienia stosu . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby było na temat przepełnienia stosu. Zamknięte 2 lata temu . Popraw to pytanie Jedną z nowych funkcji Xcode 5 jest możliwość udokumentowania własnego kodu za pomocą specjalnej …

2
pandy ponownie próbkują dokumentację
Więc całkowicie rozumiem, jak używać resample , ale dokumentacja nie wykonuje dobrej roboty wyjaśniającej opcje. Dlatego większość opcji w tej resamplefunkcji jest dość prosta, z wyjątkiem tych dwóch: reguła: ciąg przesunięcia lub obiekt reprezentujący konwersję celu jak: ciąg, metoda pobierania lub ponownego próbkowania, domyślnie „oznacza” Patrząc na tyle przykładów, ile …

2
Co umieścić w docstring modułu Pythona? [Zamknięte]
Zamknięte . To pytanie jest oparte na opiniach . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby można było na nie odpowiedzieć za pomocą faktów i cytatów, edytując ten post . Zamknięte 2 lata temu . Popraw to pytanie Ok, więc przeczytałem zarówno PEP 8, jak i …


8
Jak udokumentować zgłoszone wyjątki w języku C # / .net
Obecnie piszę mały framework, który będzie używany wewnętrznie przez innych programistów w firmie. Chcę zapewnić dobre informacje Intellisense, ale nie jestem pewien, jak udokumentować zgłoszone wyjątki. W poniższym przykładzie: public void MyMethod1() { MyMethod2(); // also may throw InvalidOperationException } public void MyMethod2() { System.IO.File.Open(somepath...); // this may throw FileNotFoundException …


5
Dokumentacja / samouczek interfejsu API FFmpeg C [zamknięty]
Zamknięte. To pytanie nie spełnia wytycznych dotyczących przepełnienia stosu . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby było na temat przepełnienia stosu. Zamknięte 12 miesięcy temu . Popraw to pytanie Próbuję znaleźć dokumentację dotyczącą korzystania z interfejsu API FFmpeg C. Wygląda na to, że dostępna jest …
119 c  api  documentation  ffmpeg 

26
Czy widać następcę TeX / LaTeX? [Zamknięte]
Zamknięte . To pytanie jest oparte na opiniach . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby można było na nie odpowiedzieć, podając fakty i cytaty, edytując ten post . Zamknięte 6 lat temu . Popraw to pytanie TeX / LaTeX jest świetny, używam go na wiele …
118 documentation  latex  tex 


1
Jak określić tablicę obiektów jako parametr lub wartość zwracaną w JSDoc?
W JSDoc, najlepsza dokumentacja, jaką mogę znaleźć, pokazuje użycie następującego, jeśli masz tablicę określonego typu (na przykład tablicę ciągów), taką jak: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Jak zamienić poniższe znaki zapytania na tablicę obiektów? /** * @param {???????} myObjects All …

4
Jak interpretować parametry funkcji dokumentacji API?
Czy istnieje standard interpretacji składni interfejsów funkcji w dokumentacji API, a jeśli tak, to w jaki sposób jest on definiowany? Oto przykład zmiany koloru elementu w przewodniku skryptów JavaScript dla programu Photoshop dla funkcji „fillColor”: fillPath ([fillColor] [, mode] [, opacity] [, preserveTransparency] [, feather] [, wholePath] [, antiAlias]) Jakie …
104 api  documentation 

Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.