documentation

существуют ли автоматические способы синхронизации комментариев между интерфейсом и его реализацией? В настоящее время я документирую их обоих и не хотел бы вручную синхронизировать их. обновление: рассмотрим этот код: interface IFoo{ /// <summary> /// Commenting DoThis method /// </su...

Я читаю руководство по написанию сценариев JavaScript для Photoshop, Illustrator и InDesign. API действительно трудно читать, потому что он предполагает, что я знаю определенные условные обозначения. Проблема не ограничивается этим конкретным руководством по написанию сценариев. Я мог бы перечислить десятки, ...

когда я разбираю свой xml-файл (переменная f) в этом методе, я получаю ошибку C:Documents и настройкиjoeDesktopaicpcudevOnlineModulemap.dtd (система не может найти указанный путь) Я знаю, что у меня нет dtd, и мне это не нужно. Как я могу разобрать этот объект файла в объект документа, игнорируя ошибк...

Я только что понял из статьи в CACM, что Doxygen работает с Java (и несколькими другими языками) тоже. Но Java уже имеет инструмент Javadoc. Может ли кто-нибудь объяснить, каковы плюсы и минусы любого подхода? Являются ли они взаимоисключающими? Есть ли плагин Maven для Doxygen?...

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

в JSDoc лучшая документация, которую я могу найти, показывает, что вы используете следующее, Если у вас есть массив определенного типа (например, массив строк): /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Как бы вы заменили ни...

в настоящее время я использую JSDoc Toolkit чтобы документировать мой код, но он не совсем подходит, а именно, он, похоже, борется с описанием пространств имен должным образом. Скажем, у вас есть два простых класса в каждом их файлов: lib/database/foo.js: /** @class */ function Foo(...) {...} /** @function...

существует ли документация для C++ в Linux? Я хочу что-то вроде man pages of C. Например, документы для string, stl, iostream, ifstream и т. д.?...

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

Я пишу спецификацию для RESTful API для новой внутренней веб-службы. Это не очень долго и довольно просто, но даже так, это мой первый раз, когда я использую строгий отдых (в отличие от обмана по практическим причинам - избегая PUT и DELETE потому что они боль в PHP, и так далее). Мне было интересно, существу...