GitHub — различия между версиями
George (обсуждение | вклад) м (→Участники) |
George (обсуждение | вклад) м (→Документация) |
||
| Строка 24: | Строка 24: | ||
== Документация == | == Документация == | ||
| − | === [http://www.stack.nl/~dimitri/doxygen/index.html | + | === [https://guides.github.com/features/mastering-markdown/ Markdown] === |
| − | + | ||
| + | '''Markdown''' – язык разметки, широко используемый в git-репозиториях. Текстовым файлам, написанным с использованием '''markdown''' принято присваивать расширение '''.md'''. | ||
| + | |||
| + | Традиционно репозитории содержат следующие файлы: | ||
| + | * [https://gist.github.com/PurpleBooth/109311bb0361f32d87a2 '''README.md'''] – описание проекта, процедур сборки, установки и использования ПО, ссылки на авторов и документацию; | ||
| + | * [https://gist.github.com/PurpleBooth/109311bb0361f32d87a2 '''CHANGELOG.md'''] – описание изменений между разными версиями ПО. | ||
| + | |||
| + | Файлы с разметкой '''markdown''' с помощью '''doxygen''' могут быть преобразованы в отдельные страницы документации. | ||
| + | |||
| + | === [http://www.stack.nl/~dimitri/doxygen/index.html Doxygen] === | ||
| + | '''Doxygen''' — гибкий инструмент генерации программной документации по исходному коду. | ||
По умолчанию doxygen поддерживает C++, Python и другие языки ([http://www.stack.nl/~dimitri/doxygen/manual/features.html список возможностей]). | По умолчанию doxygen поддерживает C++, Python и другие языки ([http://www.stack.nl/~dimitri/doxygen/manual/features.html список возможностей]). | ||
Также есть [http://www.stack.nl/~dimitri/doxygen/helpers.html ряд расширений], добавляющих поддержку Matlab, позволяющих интегрировать doxygen в Visual Studio и др. | Также есть [http://www.stack.nl/~dimitri/doxygen/helpers.html ряд расширений], добавляющих поддержку Matlab, позволяющих интегрировать doxygen в Visual Studio и др. | ||
| − | Если для формальной отчётности требуется оформить документацию на | + | В первую очередь следует использовать doxygen доя генерации html. Если для формальной отчётности требуется оформить документацию на программное обеспечение, без дополнительных изменений кода программы '''doxygen''' позволяет пересоздать документацию в виде rtf-файла (с автоматической нумерацией и программируемыми полями), который затем можно открыть в Microsoft Word и сохранить в нужный формат. |
Версия 02:00, 26 октября 2018
Централизованный аккаунт: @gpn-polytech
По адресу почты @spbstu.ru можно оформить студенческий аккаунт.
Приложение: GitHub Desktop.
Содержание
Участники
- Антонов Илья – @antoidco
- Калюжнюк Александр – @iomguy
- Краева Светлана – @svetlanakraeva
- Лапин Руслан – @FanOfRammstein
- Марков Николай – @mksfmksf
- Мурачёв Андрей – @anewmur
- Мущак Никита – @NikitaMushchak
- Осокина Алена – @ElaineEddington
- Старобинский Егор – @starobinskii
- Хлопин Сергей – @hlserg
- Цветков Денис – @AHuxley
- Шварёв Николай – @megameowmeow
Проекты
Документация
Markdown
Markdown – язык разметки, широко используемый в git-репозиториях. Текстовым файлам, написанным с использованием markdown принято присваивать расширение .md.
Традиционно репозитории содержат следующие файлы:
- README.md – описание проекта, процедур сборки, установки и использования ПО, ссылки на авторов и документацию;
- CHANGELOG.md – описание изменений между разными версиями ПО.
Файлы с разметкой markdown с помощью doxygen могут быть преобразованы в отдельные страницы документации.
Doxygen
Doxygen — гибкий инструмент генерации программной документации по исходному коду.
По умолчанию doxygen поддерживает C++, Python и другие языки (список возможностей). Также есть ряд расширений, добавляющих поддержку Matlab, позволяющих интегрировать doxygen в Visual Studio и др.
В первую очередь следует использовать doxygen доя генерации html. Если для формальной отчётности требуется оформить документацию на программное обеспечение, без дополнительных изменений кода программы doxygen позволяет пересоздать документацию в виде rtf-файла (с автоматической нумерацией и программируемыми полями), который затем можно открыть в Microsoft Word и сохранить в нужный формат.
