FPDoc Editor/ru: what changed
Revision 0 to 1. Removed lines have a minus sign; added lines have a plus sign.
Title: FPDoc Editor/ru
| Old | New | Line | |
|---|---|---|---|
| 1 | + | ## Вступление | |
| 2 | + | ||
| 3 | + | FPDoc это встроенное в Lazarus средство для формирования документации к модулям Free Pascal. Подробное описание FPDoc есть на английском языке: [Free Pascal documentation tool manual](http://www.freepascal.org/docs-html/fpdoc/fpdoc.html). | |
| 4 | + | ||
| 5 | + | <figure> | |
| 6 | + | <img src="FPDocEditorDescription.png" title="FPDocEditorDescription.png" /> | |
| 7 | + | <figcaption>FPDocEditorDescription.png</figcaption> | |
| 8 | + | </figure> | |
| 9 | + | ||
| 10 | + | Lazarus включает средство просмотра FPDoc-справки во всплывающих подсказках к именам в исходном коде и два редактора FPDoc, которые могут использоваться для создания и поддержки документации к исходникам. Более простой редактор интегрирован в Lazarus IDE так и называется, **FPDoc Editor** (Редактор FPDoc), и именно он описан на этой странице. Для его работы достаточнов настройках Lazarus в разделе FPDoc добавить пути к папкам с документацией. | |
| 11 | + | ||
| 12 | + | Существует также более мощный редактор, который называется [[Lazarus Documentation Editor|LazDE]]. **LazDE** - старший брат **FPDoc Editor**, и полностью называется Lazarus Documentation Editor. Это самостоятельное приложение, оно не интегрировано в Lazarus IDE. Поставляется в исходниках, проект расположен в папке (\$LazDir)/doceditor/lazde.lpi. Скомпилируйте проект lazde однажды (используя Lazarus), и затем запускайте LazDE независимо. Можно добавить его в меню Tools (Сервис) как "внешнее средство". | |
| 13 | + | ||
| 14 | + | ## Использование редактора FPDoc | |
| 15 | + | ||
| 16 | + | Чтоб воспользоваться FPDoc Editor достаточно: | |
| 17 | + | ||
| 18 | + | 1\. Открыть пункт FPDoc Editor (Редактор FPDoc) в меню View (Вид). | |
| 19 | + | ||
| 20 | + | 2\. В редакторе исходного кода Lazarus поставить курсор на нужный элемент кода. Вы заметите, что заголовок окна редактора FPDoc изменился, и показывает имя этого элемента вместе с именем файла документации. В редакторе FPDoc Вы можете перейти на подходящую вкладку чтобы редактировать соответствующий тег документации. И естественно, Вы можете использовать редактор FPDoc и для просмотра имеющейся документации, не начиная менять её. | |
| 21 | + | ||
| 22 | + | 3\. Нажать кнопку Create Help (Создать элемент справки). Если Вы ещё не настроили пути для файлов FPDoc, IDE спросит, где хранить генерируемые файлы. Обычно у каждого проекта создают свою папку 'docs'. | |
| 23 | + | ||
| 24 | + | 4\. Вписать краткое описание | |
| 25 | + | ||
| 26 | + | 5\. Нажать кнопку Save слева или просто перейти к следующему элементу исходников (редактор автоматически сохраняет внесённые изменения по элементу, когда курсор с него уходит). | |
| 27 | + | ||
| 28 | + | ## FPDoc для поставляемых исходников LCL и самого Lazarus | |
| 29 | + | ||
| 30 | + | Лежат в папке (\$LazDir)\docs\xml, добавьте её в пути редактора FPDoc в Tools / Options / Environment / FPDoc Editor (Сервис / Параметры / Окружение / Редактор FPDoc) | |
| 31 | + | ||
| 32 | + | ## Редактирование FPDoc для поставляемых исходников FPC, RTL and FCL | |
| 33 | + | ||
| 34 | + | Файлы FPDoc для исходников FPC могут быть взяты из svn: | |
| 35 | + | ||
| 36 | + | ``` bash | |
| 37 | + | cd /home/username/yourchoice/ | |
| 38 | + | svn co http://svn.freepascal.org/svn/fpcdocs/trunk fpcdocs | |
| 39 | + | ``` | |
| 40 | + | ||
| 41 | + | Добавьте путь */home/username/yourchoice/fpcdocs* в Tools / Options / Environment / FPDoc Editor (Сервис / Параметры / Окружение / Редактор FPDoc) | |
| 42 | + | ||
| 43 | + | Для проверки результата можно посмотреть, например, на FPDoc для *TComponent.Name*. | |
| 44 | + | ||
| 45 | + | ## Планы на будущее | |
| 46 | + | ||
| 47 | + | Список todo сейчас содержит следующие пункты (расположены не в порядке приоритетности): | |
| 48 | + | ||
| 49 | + | - Write a help editor for topics. | |
| 50 | + | - Create nicer HTML output for the hint windows. | |
| 51 | + | - Support Operators | |
| 52 | + | ||
| 53 | + | ### Уже сделано | |
| 54 | + | ||
| 55 | + | - Extend the link editor to show packages and identifiers | |
| 56 | + | - Add documentation tags "example" to FPDoc Editor | |
| 57 | + | - Add documentation tags "topic" to FPDoc Editor | |
| 58 | + | - Make FPDoc Editor create new elements in documentation | |
| 59 | + | - Make FPDoc Editor create new documentation files | |
| 60 | + | - Adding a small toolbar makes it possible to use the available markup tags | |
| 61 | + | - Make FPDoc Editor work on keydown in source code editor | |
| 62 | + | - Add FPDoc Editor to IDE settings (showing and position in IDE) | |
| 63 | + | - Make it work for fpc sources (rtl files already exist) | |
| 64 | + | - Add settings to environment menu | |
| 65 | + | - Make it work on project files also | |
| 66 | + | - Propose to expand documentation tags with: "todo" and "notes" (no need for that, as there are alternatives) | |
| 67 | + | - Reduce overhead even further | |
| 68 | + | - All source elements are interpreted by FPDoc Editor using codetools | |
| 69 | + | - Find inherited entries. For example TControl.Align of TButton.Align | |
| 70 | + | - Optimization: inherited Entries are parsed on idle | |
| 71 | + | - Optimization: xml files are cached, and only parsed once or if they changed on disk | |
| 72 | + | - Add a HTML viewer. This is available by installing the turbopoweriprodsgn package | |
| 73 | + | - Checks for invalid xml tags and auto repairs them | |
| 74 | + | ||
| 75 | + | --- | |
| 76 | + | *From the Free Pascal wiki, page "FPDoc Editor/ru", as it stood on 2020-08-22 after a change by Nashev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* | |
| 77 | + | Category: Russian (unfinished translation) |