Всем привет.

Возникла задача проанализировать качество исходного кода одного проекта.
Никогда с такими задачами не сталкивался, поэтому даже не знаю по каким критериям его проверять...

Набросал за утро следующее:
1) Соответствие стандартам (тут нужна тулза, кот прошлась бы по коду)
2) Качество модели классов: сложность поддержки, расширения, ...
3) Читабельность (чисто субъективная характеристика, но, ихмо, очень важная)
4) Объем и сложность функций (можно отнести к первому пункту)
5) Всякие неиспользуемые, неинициализированные переменные, неотловленые эксепшены, частое исползование копипаста и дыды.


Проект на .Net, но это касается только тулзы для анализа кода, все остальное будет делаться руками, так что приветствуются идеи и критерии всех, а не только .net-чиков.

Зарание спасибо, ivashkanet.

посмотри этот топик, я как раз об этом говорил.
Есть Microsoft Code Conventions (как бы полуофициально, recomendated) и для их проверки разработана утилита FxCop и библиотеки, содержащие сами rules (бизнес-классы, реализующие определенные проверки). Архитектура известная - плагины, как и в unit testing, ccnet и т.д. и т.п.

Можно работать как в итерактивном, так и в командном режиме, с выводом репорта в файл. В инете много инфы по этому поводу.

Но для меня было одно "но" (см. топик) - FxCop не проверит коментарии, curly braces чтоб каждая на отдельной строке была, использование сокращенных типов (int, а не System.Int32) и т.п. Компилятор многие вещи игнорирует и в откомпилированной dll/exe твоего правило может вообще не быть.

Да еще мне сайты нужно было проверять, а они так просто в dll не билдаются. Нужно aspnet_compiler.exe вызывать...
Так что я сделал 2-х ярусную проверку: 
- сделал dll для FxCop с моими правилами, с теми, что можно хоть как-то проверить
- мое виндовс-приложение требует входные данные (пути к сайту, пути к моим FxCop-dll), и сначала текстовым и ReGex парсингом проверяю то, что нельзя проверить FxCop-dll, а парсингом можно , потом вызываю фоново aspnet_compiler.exe, потом, фоново - FxCop в командном режиме.

Могу кинуть проект на мыло. Но нужно немного времени (наши Code conventions ты не знаешь, прийдется многое до-комментировать).

P.S. а некоторые вещи я так и не смог проверить... ни моими танцами с бубном, ни FxCop-ом.

Это сообщение отредактировал(а) tol05 - 23.1.2008, 11:46

ivashkanet, привет.

Для анализа кода нужна хорошая QA-платформа, а насколько я знаю все серьезные приложения в данной сфере платные, причем хорошо платные. Если кто-то подкинет хорошую программку, то скажу большое спасибо.  
Как пример. Средней паршивости программа.

В принципе это работа для грамотного QA-специалиста, который знает стандарты и критерии оценки. И сможет изложить все огрехи в виде отчета. Это отдельная специальность требующая соответственной подготовки, подручными средствами тяжело обойтись в серьезном проекте.

Для Java в средах разработки часто имеются code ispector'ы, осуществляющие:

а) стилистическую проверку (стандарты именования, обращение к статическим полям через имя класса, а не экземпляра и т.п.)
б) некоторую проверку семантики (неиспользуемые публичные методы, например)
в) проверку "откомментированности" кода
г) и кое-что ещё.

Мне больше всего нравится инспектор в IntelliJ Idea. Очень много всего сечёт.

Наверняка, и для .NET такие штуки есть.

Что именно проверять нужно я не знаю, это все еще придет.
Код этот писался не нами, так что непонятно какие стандарты там использовались.


Для .Net тоже есть (например в 2008 студии, только я еще не разобрался как с ним работать). Дело только в том, что я с этим никогда не работал.

tol05, Retro, спасибо за линки я гляну.


Эхххх, жисть моя жестянка. А что еще делать? Начальство сказало делать, значит делать  

Во-первых, это настраивается, а во-вторых, навряд ли они отступают от рекомендованных Code Conventions.

Помогут тебе ReSharper и обыкновенный Code Analysis из Студии 

Да, стал браузить инет и нашел, что именно его все и советуют. Но он есть только Team System Edition. Будем искать его и разбираться. На данный момент это, ИМХО, самый перспективный вариант.

  


не, ну я не спорю, решарпер крут... Только мне нужно было сайты из source safe брать и проверять. По нескольку тысяч файлов. Так что открывать их в студии и решарпером проверять... как-то даже не думал.

Говорю то, что делал, а выбирать - вам   

P.S. ну ... может про "несколько тысяч" я и "загнул"... но больше 30 проектов... Тысяча где-то была...

Это сообщение отредактировал(а) tol05 - 23.1.2008, 12:53

tol05, насколько я понял, открываешь проект в студии и командуешь: анализировать.
Он тебе выкидывает кучу ворнингов: тут не так написано, здесь фигня заюзана,...
И ты потом это все анализируешь.

Он даже XML-re создает с результатами анализа, только я еще не разобрался кому ее можно скормить, чтобы получить сгруппированный отчет... Хотя можо самому трансформацию написать...

у нас 2005-я юзается, там Code Analysis есть?
да даже если бы и была... Она проверяет то, что написано в моих "CodeConventions"?

не думаю. Иначе мне бы не стали платить эстимэйты за мою тулзовину. 

Подвожу итог мне было поставлена задача и я ее выполнил лписанным мной способом. 

tol05, да, VS2005 Team Edition содержит эту фичу.

Да, пишешь свой класс правил и поехал.
Даже больше, можно подключать FxCop-ие правила.

Нашел такую страничку: http://sharptoolbox.com/categories/code-an...dards-verifiers просматриваю...

ivashkanet, когда мне таск поставили, я первым делом тулзы искать кинулся. И многие пересмотрел. 
Повторяю - они проверяют только тот набор правил, который определил разработчик каждой конкретной тулзы. 
Мне не подошла ни одна (я имею в виду полностью). 

Поэтому я не только

но и еще дописал то, что "не ездит" на FxCop. А так, чтобы подбирать несколько тулзовин разных производителей и 20 правил проверять одной, 15 - другой и еще тремя тулзованами - по 1 правилу ... Моих заказчиков такой бардак не устраивал. 
Им нужно чтобы было по максимуму: выбрать две папки и нажать на две кнопки, получить файл и отправить его девелоперу читать.


Это сообщение отредактировал(а) tol05 - 23.1.2008, 17:58

У меня нет конкретного набора правил. Мне бы вообще хоть как-тол проверить 

Если не знаешь, куда плывёшь, никакой ветер не будет попутным (с) либо Спиноза, либо Сенека, либо Конфуций

Либо все вместе взятые, но толку от этого никакого...

batigoal, цель этого топика и выяснить по каким критериям оценивать исходники. На данном этапе меня вполне устраивают правила типа "Microsoft .net best practices" которые и заявляются в большинстве таких тулзовин.

+1 за FxCop, только относись к его предложениям с известной долей скептицизма. 

А критерии оценки тебе что, не сообщили? Задача вида "пойди куда-нибудь, сделай что-нибудь и напиши отчет"?   

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

ivashkanet, дык спосите у него, что ему нужно в результате. Ревьюить можно по-разному, например на секьюрность, или соответствие стандарту кодирования (какому?), или на расширяемость, или под конкретную задачу, и т.п.

arilou, да понимаю я все это.
Дело в том, что он хочет чтобы мы проверили на "хорошо ли написан код". А если мы ему начнем перечислять 

то он скажет: ДА, Да, ДА!!!, и это заверните.

Добавлено через 1 минуту и 30 секунд
Тем более сейчас все это затихло, так я держу крестики, чтобы не выползло опять   

Это сообщение отредактировал(а) ivashkanet - 24.1.2008, 17:40

ivashkanet, ну смари сам