SublimeText - добавить комментарии * о * код?

345
BruceWayne

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

Я не имею в виду комментарий кода, используя в качестве примера python:

def some_function(): my_variable = 123  my_array = [123,345,345] #this next line will do some math final_val = 1+2

Я имею в виду комментарий, который позволяет мне расширить предмет. Например, я учусь matplotlibи хотел бы добавить комментарий о том xycoords, какими могут быть различные типы.

В настоящее время это неуклюже и занимает тонну строк:

enter image description here

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

Используя Word, чтобы показать неуклюжий пример:

enter image description here

Изменить: чтобы быть ясным, мне просто нужны эти комментарии доступны в Sublime. Они не предназначены для того, чтобы быть частью опубликованного / полного заявления. Это только для меня, пока я программирую в SublimeText

0
Вы спрашиваете, что есть способ добавить метаданные, однако поддержка метаданных является функцией формата файла больше, чем само приложение. Если он должен быть частью приложения, потребуются дополнительные файлы или какая-то база данных и функции, которые связывают конкретные комментарии с конкретными местами в конкретных файлах. Другими словами, вероятно, нет. music2myear 6 лет назад 0
@ music2myear - я спрашиваю, как добавить заметку для меня, программиста, в Sublime. Допустим, в приложении, когда оно публикуется онлайн, я не хочу, чтобы этот комментарий был там. Это только для меня, как я учусь. Это метаданные? По сути, вместо того, чтобы продолжать посещать Google или веб-страницу для просмотра информации, я хотел бы просто добавить комментарий в Sublime-Text, к которому я могу обратиться вместо этого. BruceWayne 6 лет назад 0
Затем вы ищете базу данных комментариев и какую-то систему для связи комментариев с файлами / кодом. Либо есть плагин, который делает это, либо нет. Учитывая, что большинство людей просто используют регулярные встроенные комментарии в коде для такого рода вещей, я бы предположил, что такой инструмент может быть не слишком востребован, и, следовательно, вероятность его существования достаточно мала. music2myear 6 лет назад 0

1 ответ на вопрос

0
Isaac Corbrey

Просматривая документацию Sublime Text, кажется, что этот тип поведения не поддерживается. Однако альтернативой может быть установка пакета, такого как Fold Comments, который позволит вам свернуть многострочные комментарии в вашем коде.

Похожие вопросы