Результаты поиска по запросу "documentation"

3 ответа

Java Swing: список всех свойств UIDefaults

Вопрос: Где я могу получить список всех свойств UIDefaults, которые существуют в Swing? Я знаю о возможности написания небольшого фрагмента кода, который просто извлекает и отображает их, но я хотел бы знать, является ли список, который ...

5 ответов

Унаследовать строки документов в наследовании классов Python [закрыто]

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

10 ответов

Какие бы правила мы ни использовали сегодня, чтобы сделать наш код более читабельным, через 10 лет это будет выглядеть старомодно и глупо. Если вам действительно нужна лучшая читаемость кода, прочитайте какой-нибудь старый код (учтите, сколько времени ему нужно для работы на машине с тысячной скоростью и памятью), постарайтесь понять его и поощрить кого-то другого сделать то же самое.

дело доходит до документации кода, обычно считается, что код долженобъяснии документация встроенного кода (исключая общедоступную документацию API) должна только объяснять проблемы метакода, такие как обходные пути, объяснения, почему были ...

ТОП публикаций

5 ответов

 Посмотрите в модулях конкретные методы.

аюсь узнать как можно больше об AREL. Но я не уверен, на что смотреть. Я нашел некоторыедокументация по Rubydoc [http://rubydoc.info/github/rails/arel/master/frames], но это не очень хорошо с точки зрения демонстрации того, что «общедоступный ...

3 ответа

и подход выше в этом случае терпит неудачу.)

я определил внутреннюю цель гиперссылки, как я могу ссылаться на нее, используя произвольный текст в качестве заголовка ссылки? Например: _`This is a very long internal link target`. ... A `short reference`_ to the very long link target.Как я ...

1 ответ

http://www.stevesouders.com/blog/2008/03/20/roundup-on-parallel-connections/

аюсь заполнить списокофициальные ссылки на документациюозначения по умолчанию* Максимальное количество одновременных соединений HTTP / 1.1 на сервер для текущих (2011) основных браузеров. Вот что у меня так далеко: Firefox 4.x: 6 (ссылка ...

4 ответа

 Имеется в виду, с какой версии релиза будет поддерживать этот интерфейс и т. д. [1.3] Ювал Адам интересен, но это не стандарт, цель java doc понятна каждому.

ли причина включать оба@version а также@since как часть класса? Они кажутся взаимоисключающими. Кроме того, что делает%I% а также%G% значит, а как их установить / использовать? @version %I%, %G%Спасибо

2 ответа

нет. Вы должны определить имя метода / класса в комментарии. Это плохо. (если вы переименуете метод, вы должны обновить комментарий)

способгенерировать документацию автоматически из моего проекта Javascript, Кто-нибудь знает, как я могу это сделать? Насколько я знаю, есть некоторые инструменты, такие какJSDoc [http://code.google.com/p/jsdoc-toolkit/]но я хочу знать ваше ...

1 ответ

@ Зейн, я согласен. Как любитель Doxygen, я слишком сильно упустил полностью автоматическое создание справочников по API. Проверьте мой ответ, так как некоторые другие опции теперь доступны.

равится doxygen для создания документации кода на C или PHP. У меня есть предстоящий проект Python, и я думаю, что я помню, что Python не имеет/* .. */ комментарии, а также имеет свой собственный механизм самодокументирования, который, кажется, ...

2 ответа

В Visual Studio 2017 это можно найти на

я есть проект C # в vs2010, который генерирует файл документации XML, где я установил путь вывода сгенерированного файла в путь вывода проекта. Моя проблема заключается в том, что файл не обновляется, когда путь к файлу документа совпадает с ...