Любой хороший инструмент для быстрого перехода к программной документации

Question

Вопрос, выделенный жирным шрифтом. Это вопрос программирования, поэтому не подходите к выводам и голосуйте за закрытием.

Я программист на С ++. Я использую OS X/quicksilver или ubuntu/compiz/gnome do как мой рабочий стол. Я стараюсь не прикасаться к мыши, и я использую несколько рабочих столов, и я использую разбиение обоих этих дисков с клавиатуры. Для программирования я использую bash и vim.

Как я программист на C++ Мне нужно ссылаться на документацию, разбросанную повсеместно, например, буферы STL/Boost/CMAKE/zeromq/protocol/Mongodb/rapidJson/luajit, и этот список можно продолжить.

Прыжки к различным справочным руководствам - это разрушитель рабочего процесса в режиме реального времени. Возможно, вы не уверены, что это действительно проблема, но если вы используете несколько библиотек из boost, без завершения кода, вы поймете, что это действительно проблема. Как люди справляются со своими справочными ссылками, и что является самым быстрым способом перейти к справочным руководствам? Стандартные закладки браузера не являются ответом, и все, что вы предлагаете, должно выполняться в минимальном количестве нажатий клавиш, или минимальная латентность от информации нуждается в синтезе, чтобы информация была удовлетворена.

Возможно, пользовательский браузер или мощные плагины, которые я не знаю? Для навигации по каталогу я использую vim's NERDTree, возможно, что-то вдоль этих строк? Например, я должен иметь возможность набирать boost-файловую систему и иметь возможность перейти непосредственно на страницу ссылок на код в форматированной файловой системе.

Answer 1

I типа сдвиг + к для просмотра C страницы человека.

Answer 2

Я боюсь, что вы хотите, это IDE, которую Vim, как бы мне ни понравилось, не является.

a plugin that gives access to the standard library documentation. Тем не менее, Vim сам по себе не может понять ваш код и магически адаптироваться к любой библиотеке, которую вы включаете в свой проект. Vim Wiki также имеет twopages, что может представлять интерес.

Answer 3

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

Например, я написал небольшую Ubiquity команды, которая позволяет мне быстро открыть последнюю документацию любого объекта Qt, просто путем замены в Firefox, набрав Ctrl + пространства для вызова консоли Ubiquity, а затем ввести qt QSomeClass ,

Вот полный код команды Ubiquity (если вы уже установили Ubiquity, вы можете подписаться на канал команды на this blank page):

CmdUtils.makeSearchCommand({ 
    names: ["qt"], 
    author: {name: "Luc Touraille"}, 
    url: "http://doc.qt.nokia.com/main-snapshot/{QUERY}.html", 
    icon: "http://qt.nokia.com/favicon.ico", 
    description: "Searches the Qt Documentation for your word." 
}); 

Как вы можете видеть, это очень просто и может легко адаптируются для другой онлайн-документации, , если URL-адрес хорошо сконструирован.

Редактировать

Вот более общий вариант, который вы можете адаптировать к вашим потребностям (вам просто нужно заполнить карту шаблоны):

var urlTemplates = { 
    "QT": "http://doc.qt.nokia.com/main-snapshot/{QUERY}.html", 
    "MPL": "www.boost.org/doc/libs/release/libs/mpl/doc/refmanual/{QUERY}.html", 
    ".NET": "http://msdn.microsoft.com/en-us/library/{QUERY}.aspx" 
}; 

CmdUtils.CreateCommand({ 
    names: ["doc"], 
    author: {name: "Luc Touraille"}, 

    arguments: [ {role: "object", 
        nountype: /^[0-9a-zA-Z_.-]*$/, 
        label: "entity" 
       }, 
       {role: "source", 
        nountype: [source for (source in urlTemplates)], 
        label: "documentation" 
       } ], 

    description: "Searches the documentation for some entity on a given documentation reference.", 

    _getSearchResultUrl: function(arguments) { 
     var documentationSource = arguments.source.text; 

     var urlTemplate = urlTemplates[documentationSource.toUpperCase()]; 

     return urlTemplate.replace("{QUERY}", arguments.object.text); 
    }, 

    execute: function(arguments) { 
     Utils.openUrlInBrowser(this._getSearchResultUrl(arguments)); 
    } 
}); 

Пример использования:

doc QMainWindow from qt 
doc from mpl vector 
doc system.idisposable from .net 
doc this from .net // with some text selected 

Конечно, это очень наивная реализация, которая потерпит неудачу на большинстве сайтов. Более развитый подход может заменить шаблоны URL-адресов на карте по функциям, тем самым обеспечивая больший контроль над построением целевого URL-адреса. Я оставлю это как упражнение для читателя :). Другим решением может быть поиск на веб-сайте (при условии, что он обеспечивает правильный REST API для поиска) и перейти к первому результату.