Как правильно документировать файлы, классы и конструкторы?
В Java, 'международный' тип является примитивом, тогда как 'Целочисленный' тип является объектом.
В C#, 'международный' тип совпадает с System.Int32 и тип значения (т.е. больше как Java 'интервал'). Целое число (точно так же, как любое другое значение вводит) может быть , упаковал ("обернутый") в объект.
различия между объектами и примитивами несколько выходят за рамки этого вопроса, но подводить итог:
Объекты предоставляют средства для полиморфизма, передаются ссылкой (или более точно передай ссылки значение), и выделяются от "куча" . С другой стороны примитивы являются неизменными типами, которые передаются значением и часто выделяются от стек .
2 ответа
Лично я комментирую в конструкторах, только если есть что-то особенное, чтобы прокомментировать это (например, специальная инициализация).
Я бы не сказал, что это «самый полезный» способ, но он сохраняет код в чистоте, и повторять два раза одно и то же не нужно (если это ваше беспокойство).
Лично я считаю, что документация по классам и методам - самая важная документация. Когда я пишу код, мне нужна помощь моей IDE, когда завершение кода показывает мне документацию, относящуюся к методу. Таким образом, я легко могу найти нужный мне метод.
Поскольку я стараюсь свести явную инициализацию классов к минимуму, я не использую комментарии конструктора. Поэтому я стараюсь избегать использования самих конструкторов.
Код в методе или функции должен быть максимально понятным, используя декларативные имена переменных и сохраняя их как можно меньшими. Только когда я делаю что-то неожиданное, например, для проблем интеграции, я комментирую их.