Как создать многоязычный JavaDocs?
"Так, мы хотели бы создать версию Java нашего базового механизма, идеально не поддерживая отдельную основу исходного кода Java".
В основном, Вы хотите скомпилировать свой код C#, неизмененный и иметь выполненный в среде только для Java.
IKVM не , что Вы хотите. IKVM три главного .
a. ikvm - реализация CLI виртуальной машины Java (отмечают, что это использует путь к классу (теперь OpenJDK) для Библиотеки классов Java).
b. ikvmc - байт-код Java Компиляций к байт-коду CLI.
c. ikvmstub - Генерирует классы тупика Java тот вызов код CLI.
Примечание, что все эти инструменты зависят от CLI во времени выполнения. То, что Вы хотите, является точно противоположностью IKVM, который является, конечно, MVKI (Самый Почтенный Посредник Kompiler) :):
a. mvki - реализация Java виртуальной машины CLI (по-видимому, это использовало бы Моно или DotGNU для библиотеки классов).
b. mvkic - Компиляции байт-код CLI к байт-коду Java.
c. mvkistub - Генерирует классы тупика CLI, которые называют Примечание Java
, что ни один из них не потребовал бы существующей реализации Платформы.NET во времени выполнения, таким образом, они должны быть удовлетворительными для Ваших клиентов только для Java.
, К сожалению, насколько я знаю, MVKI не существует, таким образом, Вы являетесь лучшими от выполнения ручного порта (который неизбежно был бы более чистым, хотя больше работы).
Редактирование: На основе описание Mainsoft, это, кажется, подобно MVKI, хотя я не уверен, что они делают для библиотеки классов, и в отличие от IKVM это не FOSS.
2 ответа
Нет, по сути, нет способа сделать это.
Единственное решение, которое приходит на ум, относится к сгенерированным HTML-страницам: вы можете окружить JavaDocs блочными элементами, которые переключаются между языками с помощью CSS. Рассмотреть возможность:
/**
* <div class="en">Documentation in English</div>
* <div class="nl">Documentatie in Nederlands</div>
*/
public void myFunction() {}
Затем отредактируйте CSS документов JavaDocs, чтобы пользователь мог переключать языки, например:
div.en { display:none; }
div.nl { display:block; }
Короткий ответ - нет. Существующие комментарии и инструменты javadoc не поддерживают это.
Я не думаю, что было бы хорошей идеей добавить поддержку для встраивания нескольких переводов комментариев javadoc в исходный код. Это не было бы масштабируемым решением:
- По мере добавления каждого нового перевода файлы исходного кода становятся больше.
- Многоязычными описаниями будет очень трудно управлять.
Учтите, что я разработчик API кто не читает / не пишет по-китайски. Когда я обновляю английский javadocs, как мне отметить, что китайские комментарии javadoc нуждаются в обновлении? Что нам делать с проблемой, когда потенциально большое количество переводчиков нуждается в обновлении файлов исходного кода и может случайно внести регрессию в реальный код? Как менеджер выпуска гарантирует, что все переводы будут выполнены до «золотого» выпуска?
Я думаю, что лучшим (гипотетическим) решением является наличие модифицированного инструмента javadoc, который извлекает комментарии javadoc в базу данных версий. Затем напишите инструмент, который замечает, когда основной (например, английский) комментарий javadoc изменяется в базах данных, и предлагает техническим писателям / переводчикам внести соответствующие изменения в переводы javadoc на китайский, голландский и т. Д.
release?Я думаю, что лучшим (гипотетическим) решением является наличие модифицированного инструмента javadoc, который извлекает комментарии javadoc в базу данных версий. Затем напишите инструмент, который замечает, когда основной (например, английский) комментарий javadoc изменяется в базах данных, и предлагает техническим писателям / переводчикам внести соответствующие изменения в переводы javadoc на китайский, голландский и т. Д.
release?Я думаю, что лучшим (гипотетическим) решением является наличие модифицированного инструмента javadoc, который извлекает комментарии javadoc в базу данных версий. Затем напишите инструмент, который замечает, когда основной (например, английский) комментарий javadoc изменяется в базах данных, и предлагает техническим писателям / переводчикам внести соответствующие изменения в переводы javadoc на китайский, голландский и т. Д.