23
голосов
5ответов
13503 просмотров

Как следует документировать модульные тесты?

Я пытаюсь улучшить количество и качество тестов в своих проектах Python.Одна из трудностей, с которыми я столкнулся по мере увеличения количества тестов, - это знать, что делает каждый тест и как он должен помогать выявлять проблемы.Я знаю, что часть отслеживания тестов - это лучшие имена модуль...

0
голосов
2ответов
1860 просмотров

Недокументированные функции не должны быть доступны для просмотра / отображения в списке - документ выпуска только для задокументированных объектов

class EXAMPLE{ public func1() private func2() func3() } Я проверил только задокументированные объекты.У меня есть документация для func1 и func3, но нет документации для func2.У меня есть EXTRACT_ALL = NO EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRA...

23
голосов
3ответов
15688 просмотров

Проблема с получением Doxygen для документирования перечисления в C

У меня довольно странная проблема с Doxygen (1.6.1 в Mac OS X Snow Leopard) в том, что он, похоже, не документирует мои перечисления, что бы я ни делал.Я программирую на C и следую инструкциям в руководстве.Вот мой код: /** * \enum dccp_pkt_type * \brief specifies the available DCCP packet...

62
голосов
7ответов
52556 просмотров

Как автоматизировать документирование REST API (реализация в Джерси)

Я написал довольно обширный REST API с использованием Java Jersey (и JAXB). Я также написал документацию с использованием Wiki, но это был полностью ручной процесс, который очень подвержен ошибкам, особенно когда нам нужно внести изменения, люди часто забывают обновить вики. Судя по всему, бо...

3
голосов
3ответов
3938 просмотров

инструмент с открытым исходным кодом для создания документации Javadocs через Maven2 с автоматическими диаграммами UML, такими как ydoc

Я хочу создавать документы javadoc с помощью подключаемого модуля создания сайтов maven, и я хочу иметь автоматические диаграммы UML, созданные и встроенные в javadoc. В проекте statsvn используется yDoc для создания документации UML, но я думаю, что они используют Maven1. yDoc - это комм...

0
голосов
1ответов
1369 просмотров

Как опубликовать артефакты сборки CruiseControl LATEST в статический URL

У меня есть многомодульный Java-проект Maven, в котором я хочу создать сайт MVN и javadocs, а также сделать так, чтобы CruiseControl публиковал последние ежедневные сборки в настроенном статическом местоположении. Проблема в том, что artifactPublisher позволяет вам указать целевой каталог. ...

1
голосов
1ответов
1113 просмотров

Как эффективно использовать каталог документации ядра Linux?

Это может показаться аморфным вопросом, но как получить максимальную отдачу от каталога документации ядра Linux? В перекрестной ссылке Linux я заметил, что есть каталог DocBook.Как мне его построить, как использовать и насколько это полезно?Какие еще есть способы эффективного использования эт...

0
голосов
4ответов
1345 просмотров

Какой пример пользовательской документации?

Я пишу этот класс Rational number для одного из моих курсов cs, используя C ++.Нас также просят сдать «пользовательскую документацию», чего я никогда раньше не делал.Какой пример пользовательской документации?в каком формате это?Спасибо!

3
голосов
1ответов
341 просмотров

Можно ли построить отладчик на основе механизма сценариев Java?

мы используем механизм сценариев java 6 в нашем продукте, и теперь мы думаем о добавлении некоторых возможностей отладки. мой вопрос: это возможно?имеет ли механизм сценариев java 6 те же возможности, что и rhino, в части отладки. некоторая документация о том, как начать это делать, неко...

10
голосов
5ответов
11876 просмотров

Как заставить Java API Javadocs отображаться в Eclipse в Ubuntu

Я снова здесь с вопросом о документации. В моем университете при использовании Eclipse при размещении курсора над именем метода Java API (например: .size ()) я получаю очень хорошая документация по этому поводу. Вот дома я получаю Note: This element neither has attached source nor attached ...

0
голосов
1ответов
281 просмотров

CUDA: документация ядра CRT?

Я пытаюсь найти документацию по всем функциям, доступным для ядер CUDA. Справочное руководство CUDA, похоже, включает только функции хоста, а руководство по программированию CUDA включает только некоторые детали, такие как точность этих функций, но не их документацию. Мне что-то не хватает ил...

3
голосов
2ответов
788 просмотров

Объявление множества переменных для phpdoc без начала каждой с / **

У меня есть объекты с множеством переменных, которые я объявляю и объясняю в комментариях.Я очень подробно комментирую возможность дальнейшей обработки с помощью phpDoc, однако у меня пока нет опыта составления документации. Меня очень раздражает, что в нотации phpDoc каждая переменная занима...

2
голосов
2ответов
133 просмотров

Как сохранить неизменными строки справки при применении декораторов?

Как сделать так, чтобы строки справки в функциях были видны после применения декоратора? Сейчас строка документа (частично) заменена строкой внутренней функции декоратора. def deco(fn): def x(*args, **kwargs): return fn(*args, **kwargs) x.func_doc = fn.func_doc x.func_n...

3
голосов
2ответов
325 просмотров

Отображение унаследованных методов в rdoc

У меня есть программа, написанная на Ruby, в которой используется несколько уровней наследования.Во всех родительских классах реализованы методы, которые будет использовать объект дочернего класса, но когда я создаю rdoc для своей программы, страница rdoc для дочернего класса показывает только м...

4
голосов
1ответов
2561 просмотров

Добавление собственной команды в doxygen

Я хочу добавить специальную команду в мою документацию по doxygen.В основном для каждой функции C, для которой я пишу документацию, мне нужно написать, какие глобальные переменные «затронуты» в режиме чтения или записи.Это похоже на список «См. Также», только с другим заголовком. В своем файл...

3
голосов
1ответов
206 просмотров

Как документировать веб-сервис для клиента

Я разрабатываю веб-службу.Бизнес-система клиента будет интегрирована с нашей системой с помощью этих веб-сервисов.Я хочу предоставить документацию по нашему веб-сервису.Как лучше всего документировать веб-службу?

18
голосов
4ответов
2975 просмотров

Какие инструменты доступны для документирования плагинов jQuery?

Недавно я начал создавать плагины jQuery, и мне сложно задокументировать их с помощью инструментов создания документации, которые я нашел. Я пробовал: JSDoc , JSDoc-toolkit , JGrouse и веб-инструмент также. Моя самая большая головная боль заключается в том, что мои плагины кодируются как одн...

0
голосов
1ответов
90 просмотров

как построить схему отношений между несколькими службами?

не обязательно диаграмма UML, просто простой способ графически документировать отношения между несколькими системами ... системы могут быть связаны через веб-службы, связанные серверы, текстовые файлы, пакетные процессы, компоненты com + и т. д. Я думал о карте высокого уровня, показывающе...

1
голосов
4ответов
3156 просмотров

Документация для больших или маленьких проектов с PHP?

Сейчас мы много говорим о документации для программистов. Как вы справляетесь с этой частью? Каков наилучший способ познакомить нового сотрудника с «большим» проектом PHP. Что нужно новому парню? Мои мысли на данный момент: хороший исходный код документация api, созданная с помощ...

0
голосов
1ответов
1164 просмотров

Генератор документации .NET XSD

Мне нужен генератор документации XSD для .NET.Приведите ссылки. Примечание. Если это доступно с исходным кодом код, который был бы гораздо лучшим выбором. Спасибо.

1
голосов
1ответов
255 просмотров

Есть ли способ включить текстовые комментарии в javadocs?

У нас есть большая кодовая база Java (с небольшим количеством примеси Groovy), для которой, по большому счету, нет документации javadoc. Однако большая часть кода достаточно хорошо документирована в комментариях "старой школы", разбросанных по всему тексту. Сейчас мы делаем что-то вроде то...

0
голосов
1ответов
270 просмотров

Идентификатор платформы в структуре SERVER_INFO_101

Есть ли более точная документация, что означают PLATFORM_ID_DOS, PLATFORM_ID_OS2, PLATFORM_ID_NT, PLATFORM_ID_OSF или PLATFORM_ID_VMS? Константы определены в файле lmcons.h Значения можно получить в структуре SERVER_INFO_100, SERVER_INFO_101 или SERVER_INFO_102. Очевидно, PLATFORM_ID_NT...

0
голосов
1ответов
75 просмотров

Нужна хорошая книга (и) и информация о работе с неуправляемым кодом и COM с .Net

Я работаю с .Net с VS2002, и с тех пор каждый раз, когда мне приходилось работать с COM или неуправляемым кодом, было больно.Мне удавалось делать то, что ожидалось, но почти всегда выполнялась процедура проб ошибок. С меня этого достаточно, и я хочу знать, что происходит в подсобке, и понимат...

6
голосов
2ответов
3249 просмотров

Как сгенерировать сворачиваемые разделы кода в стиле rdoc?

Я создаю внутреннюю документацию для проекта C ++ с помощью Doxygen. У меня Doxygen включает источник методов и т. Д., Но это затрудняет сканирование страницы. Я бы хотел, чтобы он вел себя как rdoc и скрыл источник в блоке, который по умолчанию свернут. Я думал, что HTML_DYNAMIC_SECTIONS мож...

0
голосов
1ответов
528 просмотров

How to export C# documentation to a documentation wiki?

I am looking for something that will iterate over our model and extract each objects properties in order to build a documentation wiki. Is there a tool out there which will do such a thing? Basically I do not want to have to extract all of our documentation out of the projects by hand.

2
голосов
5ответов
632 просмотров

Document specification in markup language?

I am not sure if this makes sense so apologies before hand: is there a markup language specifically for creating document specifications? For example, if instead of giving people a template Word document for a given document they need to create, supply them with the specification in the markup la...

19
голосов
3ответов
11493 просмотров

Advice for learning Linux x86-64 assembly & documentation

Does anyone have documentation pertaining to learning the fundamentals of Linux x86-64 assembly? I'm not sure whether or not to learn it as is, or to learn x86 first, and learn it later, but being as I have an x86-64 computer and not an x86, I was thinking of learning x86-64 instead ;) Maybe so...

1
голосов
1ответов
1221 просмотров

Using MAML for conceptual documentation of library

I am working on a new library and I am using XML comments for API documentation along with SandCastle which works really well. But I need to write additional documentation which covers concepts, overall architecture, working demos etc, class diagrams etc. I have 2 options: Use some wiki engin...

2
голосов
6ответов
151 просмотров

Need to choose a suitable language to write documentation in

Currently the documentation where I work is in a bit of a state. There isn't anywhere near enough of it, and the documentation that does exist is spread out over many word documents making it hard to find anything. I'm trying to take some initiative and get it improved, and I figure the first ...

1
голосов
2ответов
962 просмотров

Mono Documentation for NotImplementedException and MonoTodo

I'm new to Mono and plan to port my application over, if possible. I've run MoMA and there are some places it has identified that I'm calling that could throw a NotImplementedException or are tagged MonoTodo. Is there anywhere I can get more information on these specific instances it's flagging d...