Опубликовал проект SysResultSet для ax2012 на gitHub

[mazzy]

Опубликовал проект SysResultSet для ax2012 на gitHub
https://github.com/mazzy-ax/SysResultSet
пока интересует насколько удобно пользоваться подобными проектами. нужно ли что-нибудь менять в выкладке? Как улучшить полезность проекта на гитхабе?
.
Буду рад вашим замечаниям и предложениям.
.
Чуть позже, после обсуждения первой выкладки, опубликую ветки для ax2009, ax4, ax3

[Bobkov]

Цитата:

Сообщение от mazzy

Как улучшить полезность проекта на гитхабе?
Буду рад вашим замечаниям и предложениям.

Обычно в корне репозитория делают файл README.md
В этом файле пишут, кому и зачем это нужно, а также инструкцию по установке, или ссылку на неё. Этот файл автоматически показывается гитхабом. Грубый пример: https://github.com/a-bobkov/frontpage

[belugin]

Есть документация, но не в стандартном формате. Завел багу

[mazzy]

Цитата:

Сообщение от Bobkov

Обычно в корне репозитория делают файл README.md
В этом файле пишут, кому и зачем это нужно, а также инструкцию по установке, или ссылку на неё. Этот файл автоматически показывается гитхабом. Грубый пример: https://github.com/a-bobkov/frontpage

да-да. попробую. спасибо.

Цитата:

Сообщение от belugin

Есть документация, но не в стандартном формате. Завел багу

)
спасибо. так вот как это выглядит.
а как думаешь, комментарии в таком формате делать у проектов для всех версий? 2009, 4,3? просто в старых версиях такого нет. но делать разные комментарии слишком громоздко и непонятно чем на самом деле методы отличаются.

===================
а может подскажете, как в гитхабе установить кодировку по-умолчанию, чтобы кракозябр не было?
и как включить подсветку синтаксиса для xpp-файлов. хотя бы по правилам java?

[belugin]

Цитата:

Сообщение от mazzy

а как думаешь, комментарии в таком формате делать у проектов для всех версий? 2009, 4,3?

Насколько я помню, она поддерживается с 2009. Можно сгенерировать xml файлы, натравить на них xslt и получить html

[mazzy]

выложил ветки для ax2012, ax2009, ax4, ax3. добавил readme.md
https://github.com/mazzy-ax/SysResultSet

основная идея - найти удобный способ публиковать и использовать опубликованные проекты.
буду признателен за замечания и предложения.

одна из вещей - это включить подсветку синтаксиса хотя бы как в java в .xpp-файлах.
опция *.xpp linguist-language=Java в .gitattributes не помогает.
буду признателен за советы.

[Ruff]

Дурной способ, но вроде работает. В каждый файл, если верить документации - в любое место - добавить строчку vim: syntax=java. Тест показал, что можно и внутри комментария:

По теме полезности. На мой вкус, раскидывать методы по разным файлам - лишнее. Я бы предпочел классический вариант: один класс = один файл, а методы можно и комментариями/документацией визуально отбить.

PS: Интересно, реально ли АХ с Гитхабом подружить, чтоб без возни с импортом/экспортом...

[mazzy]

Цитата:

Сообщение от Ruff

Дурной способ, но вроде работает. В каждый файл, если верить документации - в любое место - добавить строчку vim: syntax=java. Тест показал, что можно и внутри комментария:

прикольно. оно конечно работает:
https://github.com/mazzy-ax/SysResul...sultSet_AX.xpp
но насколько я понимаю, это команда для vim'а.
типа "ок, вим, это джава-код"
эту команду понимает и github.

но выглядит как-то уж очень некузяво.
наверняка то же самое можно сказать и специально гиту где-то в опциях

Цитата:

Сообщение от Ruff

По теме полезности. На мой вкус, раскидывать методы по разным файлам - лишнее. Я бы предпочел классический вариант: один класс = один файл, а методы можно и комментариями/документацией визуально отбить.

PS: Интересно, реально ли АХ с Гитхабом подружить, чтоб без возни с импортом/экспортом...

классический? бггг!

насколько я понимаю, первым начал порочную практику "один объект-один xpo" вот этот проект связи с гитхабом
https://github.com/Go-ERP/Ax2Git

upd: добавил немного подумав. конечно же начал эту порочную практику не этот проект. Аксапта сама выгружает объекты для системы контроля версий по принципу "один объект-один xpo". И для системы контроля версий такой принцип, может быть, и оправдан. Проект Ax2Git просто встраивается в Аксаптовскую инфраструктуру и переносит этот принцип и в гит...

объясню почему эта практика порочная:

прежде всего отступление:
сами по себе проекты на гитхабе (или где-угодно-еще) нафиг никому не нужны.
людям нужно решить конкретные задачи. пример задачи - прочитать данные из базы данных, выгрузить в Excel, связаться с гит-хабом и прочее.

для того, чтобы человеку решить задачу, человек ищет готовый код. например, на гитхабе.

готовый код - это набор взаимосвязанных объектов, которые сами по себе в отдельности не работают. мало того, этот набор может использовать другие наборы (модули, package).
================

таким образом, есть два сценария использования проекта на гит-хабе:
1. использует человек для чтения-ознакомления
2. использует компьютер для загрузки набора объектов в систему

и в обоих сценариях принцип "один объект-один xpo" только мешает использующему.

человеку сложно читать код проекте из-аз безумных #. из-за них же не включить нормально подсветку синтаксиса.
человеку сложно находить нужный метод в проекте (особенно, если метод большой и используется много где объекте)

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

===============
мне кажется, что на гитхаб нужно выкладывать:
1. каждый метод в отдельный файл, чтобы человеку было удобно
2. весь package в один xpo-файл, чтобы компьютеру было удобно импортировать в систему.

===============
мне кажется, что на гитхабе еще нужно разобраться с модулями (package) и зависимостями между модулями https://git-scm.com/docs/gitmodules

и сделать свой форк для проекта https://github.com/Go-ERP/Ax2Git

мало того, от акс7 я буду ожидать нормального взаимодействия модулей при интеграции с гитхабом )))

[Ruff]

Цитата:

Сообщение от mazzy

человеку сложно читать код проекте из-аз безумных #. из-за них же не включить нормально подсветку синтаксиса.
человеку сложно находить нужный метод в проекте (особенно, если метод большой и используется много где объекте)

1. Я говорил не про XPO, а про XPP-файлы - исходники, подчищенные от решеток и прочего мусора. К XPO вопросов нет, мне, как человеку, он собственно не интересен на гитхабе (в плане просмотра).
2. Под "классическим" я понимаю подход, принятый в C++/C#/Java - один класс = один файл.
3. Что касается поиска методов - для меня это невостребованная функция. Когда я, как Вы правильно заметили, "ищу на Гитхабе готовый код, чтобы решить некую задачу", сценарий выглядит примерно так: поисковый запрос -> переход к конкретному проекту -> беглый просмотр основных исходников и примеров (при наличии) -> принятие решения "стоит поизучать" или "ваще не то". Дальше либо проект тащится в среду разработки, где уже анализируется на порядок более удобными инструментами, либо вкладка закрывается за ненадобностью. На упомянутый беглый просмотр тратится от 2 до 15 минут. И чем меньше при этом приходится щелкать мышкой по папкам и файлам, тем для меня лучше

[belugin]

Мне кажется, вопросы по подсветке стоит задать также в сообществе гитхаба.

Стандартный контроль версий в аксапте разбивает по application objects. Это требует некоторой привычки, но вполне удобно. MS так работает, в том числе и для целей codereview.

При разбиении файлов по методам придется так же при их переименованиях рассказывать про это контролю версий (а не просто удалять старый и создавать новый) чтобы сохрнилась история.

Формат XPO безумный и непоследовательный. Его трудно будет парсить и поддерживать согласованность с изменениями.

В Ax7 перешли на XML и работа с контролем версий идет через любой плагин для VS (git в VS встроенный)