Перенесли ответ сюда.
Как уже говорили другие, будет лучше комментировать по ходу дела.
Если вам нужно добавить их пост-кодирование, то лучше зайти внутрь, посмотреть на метод и добавить комментарий.
Netbeans и Eclipse могут быть настроены на добавление комментария метода tempate с именами параметров и возвращением, добавленными для вас в правильном синтаксисе.
Я б тоже прочитала этот[^]
*лол* я бы предложил вот это:
Сделайте плохой код хорошим @ javaworld.com[^]
Хорошие идеи у ДЭМА!
Ну Все,
Спасибо за Ваш вклад ... У меня есть хорошие ответы, но нет решения. и поскольку я ухожу из этого потока без решения, я обязательно поделюсь кодом, который я пишу после того, как он работает для меня в том же потоке. Прощайте!!!
Я думаю, вам следует подумать о том, сколько работы потребуется для написания пакетного файла, который будет автоматически компилировать исходные файлы разумным образом... Я предполагаю, что вам понадобятся сложные комментарии, включающие каждый параметр - если это так, то то, что вы запрашиваете, ближе к компилятору, чем к простому скрипту (небольшое преувеличение, но какой-то серьезный синтаксический анализ определенно будет задействован :)
Мой совет-использовать решения, предлагаемые Торстеном и Шилпипом.
Спасибо за ваши комментарии,
Торстенх,
Я начал использовать eclipse для разработки java и буду рассматривать добавление комментариев как серьезное дело в будущем.
Толу,
Согласен, это сложная вещь, но, к сожалению, я нахожусь в ситуации, когда она мне нужна.
Все,
Я знаю, что это тяжелая работа с возвратом пакетного файла, но у меня есть несколько файлов java и несколько файлов CPP/H в моем наборе решений.
Я пропустил добавление блока комментариев перед всеми функциями/элементами данных.
Даже если он не является полным(точный тип аргументов и их количество), по крайней мере, я хочу иметь блоковый комментарий перед каждым методом для начала.
Как насчет чтения текстового файла, содержащего блоки комментариев шаблона и код, просто добавляя их перед элементами методов/данных?
Опять же, нет смысла автоматически создавать комментарии и оставлять их как есть. Если они задуманы как отправная точка, создавайте их по одному и сразу же наполняйте осмысленным текстом. Если вы не сделаете этого таким образом, вы никогда не сможете завершить авто-комментарии позже. Что еще хуже, позже вы даже не заметите, сколько функций вы не смогли должным образом прокомментировать.
Я думаю, что многие ppl предложили много вещей, которые я согласен со всеми нами предложил, и что лучше комментировать, когда код написан и т. д.
Мой вопрос все еще остается без ответа, есть ли у какого-либо тела какая-либо автономная функциональность, которая добавляет комментарий комментария в файл C++ и Java???
Привет Шилпип,
Спасибо за ваш ответ, но на самом деле я хотел бы добавить блоки комментариев, добавленные не через visual studio, весь процесс должен быть в пакетном режиме. кроме того, я хочу добавить блок комментариев и для Java-файлов.
Возможно ли это через Доксикомменты?
Это очень плохая идея-создавать комментарии в пакетном режиме. Все, что он делает, это интерпретирует информацию, которая уже есть, а затем преобразует ее в какую-то другую форму. Все это приводит к увеличению размера файлов и созданию ложного впечатления, что код хорошо комментируется, хотя на самом деле ничего не комментировалось.
I don't know if this toll or any other would let you do this in batch mode, but neither do I think that would be a good idea to start with. Just adding auto-generated comment lines does not really comment your code! If you comment a function you should at least hint at the assumed preconditions and expected post conditions, give valid ranges for parameter values, list possible causes for failure and exceptions, and describe the meaning of certain output values. None of that can be done automatically. You can only comment what is already obvious from looking at the function declaration. And there is no value in that, except as a starting point to fill in the sort of information I outlined above.
[edit]извините, это должно было быть в ответ новичку, а не вам[/edit]
Если вы используете Eclipse для кодирования java, у вас всегда будет возможность добавлять автоматические комментарии по умолчанию. Проверьте свои настройки предпочтений для этого. Кроме того, диалоги всегда предоставляют возможность "добавления автоматических комментариев".
Добавление комментариев позже - не очень хороший вариант-вы не будете этого делать или просто сделаете это, потому что вас заставляют это делать. Но эти комментарии никогда не будут настолько хороши, как если бы вы написали их непосредственно.
с уважением
Торстен