Изменение шаблона лицензии NetBeans по умолчанию
Самый простой способ применить свой собственный шаблон по умолчанию для лицензирования - просто изменить шаблон по умолчанию, который используется при создании нового исходного файла NetBeans. Это делается с помощью менеджера шаблонов, доступ к которому осуществляется в NetBeans через меню Сервис->Шаблоны. Это показано на следующем снимке экрана.
Можно выбрать "Лицензию по умолчанию" и нажать на кнопку "Открыть в редакторе". Когда это будет сделано, первоначальный текст будет включать в себя комментарий, который по всей сети об использовании шаблонов. Однако, следующий снимок показывает, как я изменил текст.
С этим шаблоном я могу создать новый класс или интерфейс или другой исходный код, чтобы протестировать его. В этом случае я сгенерировал класс через мастера генерации классов NetBeans. Сгенерированный класс с измененной информацией о лицензии показан на следующем снимке экрана.
Приведенные выше примеры продемонстрировали изменение комментариев по умолчанию, включенных в каждый сгенерированный исходный файл, изменив шаблон "Лицензия по умолчанию", а не удаляя его полностью, как я показал в моем последнем блоге. Удаление ссылки на лицензию вообще или изменение "Лицензии по умолчанию" - это самый простой способ справиться с этим.
NetBeans также поддерживает возможность добавления пользовательской лицензии. В первом снимке экрана в этом посте уже доступны другие лицензии (например, лицензия Apache 2) и можно создавать пользовательские лицензии. Для этого требуется координация между свойством, называемым project.license
, в файле nbproject/project.properties
и ссылкой на этот файл в диспетчере шаблонов под типом исходного файла. Например, запись Template Manager для "класса Java" содержит следующую строку:
<#include "../Licenses/license-${project.license}.txt">
Как и следовало ожидать, местозаполнитель ${project.license}
заменяется значением, которое установлено для свойства project.license
в файле nbproject/project.properties
.
Предостережение
На момент написания этой статьи у меня возникли трудности с пользовательскими лицензиями. Когда я устанавливаю свойство project.license=dustin
и создаю шаблон лицензии в диспетчере шаблонов с именем license-dustin.txt
, чтобы он соответствовал формату, указанному в шаблоне для нового исходного кода класса Java, комментарий, который я получаю в сгенерированном файле класса Java "Ошибка чтения включенного файла Templates/Classes/../Licenses/license-dustin.txt". Я получаю это независимо от того, пытаюсь ли я выбрать файл из файловой системы или «дублировать» существующий шаблон лицензии и «переименовать» его. Редактирование любого из ранее существовавших шаблонов лицензий, поставляемых с NetBeans 6.8, кажется, работает нормально.
У простого редактирования «Лицензии по умолчанию» есть один существенный недостаток: это повлияет на все новые исходные файлы независимо от проекта. Преимущество указания файла лицензии через свойство project.license
заключается в том, что оно устанавливается на уровне каждого проекта. Однако, как я уже сказал, я не могу заставить это работать должным образом в данный момент.
Заключение
Обычно я предпочитаю просто отключать автоматически сгенерированные комментарии в верхней части файлов с исходным кодом, либо полностью удаляя ссылку на них, либо редактируя «Лицензию по умолчанию», чтобы она была пустой. Однако, если требуется пользовательский комментарий, такой как информация о лицензии и/или контактная информация в верхней части исходных файлов, NetBeans поддерживает это с помощью шаблонов лицензий.