dotnetomaniak.pl

dotnetomaniak.pl - Artykuły z tagiem dokumentacja

Tworząc projekt open source w pewnym momencie przychodzi czas, w którym należałoby nasze dzieło udokumentować celem jego zrozumienia przez innych programsitów. Dostawcy usług jak GitHub czy Bitbucket oferują wbudowane mechnizmy jak popularne Wiki, jednak według mnie posiadają one kilka zasadniczych minusów:Wiki jest nierozłączną częscią repozytorium projektu (choć można zrobić niezależny clone).Wiki nie jest (jawnie) wersjonowane. Wgląd w kolejne rewizje jest możliwy, ale nie mamy mozliwości np. utworzen...

Źródło: foreverframe.net
Dziel się z innymi:
Tworzenie dokumentacji projektowej z Read the Docs - Forever F[r]ame

Narzędzia 12 dni, 21 godzin, 6 minut temu dpawlukiewicz 103 rozwiń

Masz jakieś API chciałbyś sprawdzić listę swoich endpointów? Swagger to najlepsze narzędzie do tego – do tworzenia interaktywnej dokumentacji API.

Dziel się z innymi:
Swagger – interaktywna dokumentacja API – programmer-girl

Narzędzia 187 dni, 21 godzin, 3 minuty temu Weronika Tobor 143 rozwiń

Programiści z dokumentacją mają taki problem, że nie lubimy jej czytać i nie lubimy jej pisać. Niestety często wiąże się to z ciekawymi WTFami gdy kod zachowuje się nie tak jakbyśmy tego od niego oczekiwali.

Źródło: blog.octal.pl
Dziel się z innymi:
RTFD - Read The F* Documentation - .net blog - octal.pl | Paweł Łukasik

Sztuka programowania 387 dni, 1 godzinę, 45 minut temu Paweł Łukasik 137 rozwiń

Dokumentacja kodu w końcu ma ręce i nogi :)

Źródło: blog.gutek.pl
Dziel się z innymi:
Elixir #30 - Testy za pomocą dokumentacji - Jakub Gutkowski

Daj się poznać 2017 584 dni, 18 godzin, 26 minut temu Gutek 22 rozwiń

Writing a project documentation – everyone’s or at least the programmer’s nightmare, right? Although at a first glance many of you will most likely agree with the given assumption, I’ll try to convince you otherwise. Not only it doesn’t have to be a dull experience, but it might be a truly fun and quite refreshing activity, which shall provide the great value for the project.

Dziel się z innymi:
Documentation as a project booster | Piotr Gankiewicz

Inne 699 dni, 21 godzin, 42 minuty temu spetz 71 rozwiń

Description of my journey in search of good documentation. Main documentation principles with examples

Źródło: www.diwebsity.com
Dziel się z innymi:
[EN] Expedition in search of good documentation - Diwebsity

Sztuka programowania 807 dni, 22 godziny, 56 minut temu suvroc 60 rozwiń

C# ma tę genialną zaletę, że pozwala komentować swoją treść specjalnymi znacznikami XML. Natychmiastowym efektem takich komentarzy jest ich prezentacja w postaci pomocy kontekstowej dla elementów kodu, które zostały nimi opatrzone. Drugie ich zastosowanie, to możliwość wygenerowania dla każdego pliku z treścią oprogramowania dokumentacji zawierającej elementy opatrzone wspomnianym typem komentarza. Niestety – określanie tych plików mianem dokumentacji jest nadużyciem...

Źródło: paskol.robi.to
Dziel się z innymi:
Me z .NET tete-a-tete » Jak nie popaść we frustrację, gdy chcesz mieć dokumentację

Narzędzia 2251 dni, 8 godzin, 37 minut temu PaSkol 160 rozwiń

Nie dawno otrzymałem email z pytaniem dotyczącym tworzenia dokumentacji do kodu napisanego w C#: Poszukuje czegoś do zautomatyzowania procesu tworzenia dokumentacji dla kodu pisanego w C# i trafiłem na (..) temat odnośnie Sandcastle. Czy ten dodatek do Visual Studio pozwala tworzyć dokumentacje dla C# i jest kompatybilny z VS 2010? Spróbuję w niniejszym wpisie odpowiedzieć na to pytanie. Na temat tworzenie dokumentacji do oprogramowania pisałem już wcześniej w artykule „Tworzenie dokumentacji”. Wspomni...

Dziel się z innymi:
Tworzenie dokumentacji do kodu w C# [PL] | Maciej Zbrzezny: Programowanie i Technologie

Narzędzia 2521 dni, 8 godzin, 2 minuty temu Paweł Łukasik 614 rozwiń