Автоматическая генерация документации PHP? [закрыто]

Question

Автоматическая генерация документации PHP? [закрыто]

Тройной поиск можно эффективно использовать на параллельных архитектурах - ПЛИС и ASIC. Например, если внутренняя память ПЛИС, необходимая для поиска, составляет менее половины ресурса ПЛИС, вы можете сделать дубликат блока памяти. Это позволит одновременно обращаться к двум различным адресам памяти и выполнять все сравнения за один такт. Это одна из причин того, что 100 МГц FPGA может иногда превосходить процессор 4 ГГц:)

37

documentation-generation documentation php

задан albert 12 December 2018 в 12:37

7 ответов

Другие вопросы по тегам:

documentation-generation documentation php

Похожие вопросы:

score 0 · Answer 1

Вы могли отредактировать шаблонный файл для добавления собственной таблицы стилей для переопределения существующей.

score 4 · Answer 2

phpDocumentor может произвести в стиле, подобном документации php.net (и его встроенный и с присяжным острословом и с не разметками присяжного острослова)

score 1 · Answer 3

Если бы ugly's проблема, я просто переключил бы таблицу стилей для пользовательской. Если Вы не хотите перезаписывать сгенерированный, можно использовать плагин Firefox как Стильный .

1

ответ дан Aupajo 12 December 2018 в 12:37

1

Я действительно забывал что-то важное в своем коде выше касающегося представление... после аутентифицирования, использую django.contrib.auth.login(request, user), чтобы сказать Django сохранять пользователя в сессию. Обновленный мой ответ выше. – Ptah 12 November 2013 в 23:27

score 5 · Answer 4

Да, phpDocumentor ( http://www.phpdoc.org/ ) является приемлемым стандартным инструментом для автодокументов PHP. Это стандарт де-факто.

При документировании кода PHP приемлемо следовать общим руководящим принципам JavaDoc для кода. Однако вы столкнетесь со случаями, когда этого недостаточно, потому что PHP и Java - разные языки.

Например, функции PHP не имеют возвращаемого типа, и для функции неизбежно (а иногда и желательно) возвращать один тип с одним контекстом, а другой тип с другим контекстом. Руководства JavaDoc в этом не помогут, потому что это невозможно сделать на Java.

score 17 · Answer 5

Есть два хорошо известных и часто используемых инструмента, которые могут генерировать документацию API из блоков документов:

phpDocumentor , который специфичен для PHP и, вероятно, является одним из самых использованный инструмент для проектов PHP
и Doxygen , который больше подходит для C, но используется некоторыми людьми для PHP.

О «рекомендациях»: я бы сказал, что это зависит от ваших проектов, но, по крайней мере, я ожидал увидеть:

описание того, что делает метод / функция
параметры, с @param имя типа описание возвращаемого значения параметра
, с @return описание типа возвращаемого значения
исключения, с @throws описание типа исключения, которое может быть сгенерировано

Замечательно то, что недавняя IDE (например, Eclipse PDT ], например) ,может читать и интерпретировать эти маркеры, чтобы давать подсказки при кодировании; -)

Кроме того, появляется все больше и больше инструментов PHP, которые используют php docblocks для других целей, кроме документации.

Например, PHPUnit позволяет вам чтобы указать некоторые связанные с тестами вещи с помощью определенных тегов - см. Аннотации .

score 3 · Answer 6

Кодовая база Wordpress документирована с использованием тегов phpdoc (см. this ), и в целом она довольно хороша - она отображается здесь с использованием phpDocumentor .

Большая часть кода, который я пишу, достаточно существенный, чтобы мне нужно было подумать об автогенерации документации, сделана в .Net, поэтому я не могу дать много информации о точке зрения автора документации

score 6 · Answer 7

PHPDoc, вероятно, настолько хорош, насколько вы его получите, с точки зрения встроенного комментирования в стиле Javadoc. Вы также можете посмотреть PHPXRef .