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.
Niedawno zacząłem studiować Python , ale nie mogłem znaleźć sposobu na wdrożenie komentarzy wieloliniowych. Większość języków ma symbole blokowego komentarza, takie jak /* */ Próbowałem tego w Pythonie, ale generuje błąd, więc prawdopodobnie nie jest to właściwy sposób. Czy Python faktycznie...
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
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ć faktami i cytatami, edytując ten post . Zamknięte 2 lata temu . Widziałem kilka...
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,...
Podczas pisania dokumentacji XML można użyć <see cref="something">something</see>, co oczywiście działa. Ale w jaki sposób odwołujesz się do klasy lub metody z typami rodzajowymi? public class FancyClass<T> { public string FancyMethod<K>(T value) { return "something...
To powinno być łatwiejsze ... Chcę dodać „zakodowany” podział wiersza do dokumentacji XML w moim kodzie /// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. <br/> /// Rather than return SQL, this method returns a string with...
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...
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...
Wiem, że nie jest to najistotniejszy z problemów, ale właśnie zdałem sobie sprawę, że mogę umieścić blok komentarzy javadoc przed adnotacją lub po niej. Co chcielibyśmy przyjąć jako standard kodowania? /** * This is a javadoc comment before the annotation */ @Component public class MyClass {...
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...
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 2 lata temu . Popraw to...
Jak mogę poinformować JSDoc o strukturze zwracanego obiektu. Znalazłem @return {{field1: type, field2: type, ...}} descriptionskładnię i wypróbowałem ją: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event...
Jak udokumentować metody z parametrami przy użyciu ciągów dokumentacji Pythona? EDYCJA: PEP 257 podaje ten przykład: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag ==...
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...
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...
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...
Zamknięte . To pytanie jest oparte na opinii . 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 2 lata temu . Popraw to...
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ć...
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] [,...
Dokumentacja umożliwiającym integrację xmldoc do swoich projektów WWW interfejsu API pojawia się tylko do sytuacji, w której uchwyt wszystkich typów API są częścią projektu WebAPI. W szczególności omawia, jak przekierować dokumentację XML do App_Data/XmlDocument.xmli odkomentować wiersz w...