Свързани въпроси 'documentation-generation'

Как да документирам свойство, декларирано в различен файл с помощта на Doxygen?
Използвам mogenerator за генериране на Core Data класове. Mogenerator произвежда машинни класове и човешки класове. Разработчикът не трябва да променя машинно генерираните класове, тъй като те се генерират при всяко извикване на mogenerator....
1679 изгледи

Как да документирам метод с параметър(и)?
Как да документираме методи с параметри с помощта на документационни низове на Python? РЕДАКТИРАНЕ: PEP 257 дава този пример: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part...
150530 изгледи

VS2010: Как да промените името на файл с автоматично генерирана XML документация
Наскоро промених dll името на моя проект от ObjectCreator1.1.dll на ObjectCreator.dll . Този проект също така създава XML документация (Properties->Compile->Generate XML Documentation file). Сега проблемът е, че преименувах името на моето...
820 изгледи

Генериране на JSON от java файл
Има ли стандартен или съществуващ начин за генериране на „нещо“ от некомпилиран Java клас въз основа на неговото съдържание? Така че основно нещо подобно: @MakeJsonDocumentation public class ExistingClass{ private name = ""; public...
341 изгледи

Наименуване на doxygen @ref
Как да наименувам етикет Doxygen @ref ? Опитах следното: See @ref hello_world hello for more information Което извежда това: See hello_world hello for more information Където hello_world е свързано с hello_world . Търся този...
1974 изгледи

Кой е най-добрият инструмент за документиране/генериране на справка за RESTful/HTTP RPC API? [затворено]
Много въпроси бяха публикувани и отговориха на REST / HTTP базирани API и т.н., но никой не изглежда да разполага с много информация по следния въпрос: Какви инструменти са налични/използвани за документиране на HTTP-RPC API? Кои инструменти са...
7670 изгледи
schedule 22.04.2024

Visual Studio има ли опция за генериране на html документация за коментари в стил Javadoc?
Visual Studio има ли опция за генериране на html документация за коментари в стил Javadoc? Ако е така, какви стъпки са необходими, за да се постигне това? В BlueJ има опция за превод на коментари в стил Javadoc в html файл. Както показва...
15424 изгледи

Как да използвам luadoc в ubuntu/linux?
Както се казва в заглавието, как да използвате luadoc в ubuntu/linux? Генерирах документация в Windows с помощта на партиден файл, но без успех в Ubuntu. Някакви идеи? luadoc Usage: /usr/bin/luadoc [options|files] Generate documentation from...
525 изгледи
schedule 05.05.2024

Как да игнорирате клас при генериране на XML документация за проект на Visual Studio?
Имам проект на Visual Studio (C#), в който е активирано свойството „XML документационен файл“. Освен това има „Третирай предупрежденията като грешки“, зададено на Всички. Има един конкретен клас, който няма XML коментари и те няма да бъдат...
4158 изгледи

Как правилно да избегнете съдържанието на пример за ‹code› в Xml документация?
Кой би бил начинът за избягване на незаконните знаци на VB и C-Sharp като <>& в <code> таг на .Net Xml документация?. В този пример по-долу Intellisense подчертава знака > , защото трябва да го екранирам, той казва, че...
948 изгледи