14 ноября 2017 г.

Проверки орфографии русского языка в Visual Studio 2013/2015/2017.

Проверка орфографии, как способ упростить жизнь программисту.


Программисты, чаще всего народ грамотный, но встречаются и уникумы, у которых математический склад ума и грамматика русского языка им давалась с трудом. Это я о себе :) При написании комментариев к коду, формировании строк - я могу легко допустить грамматическую ошибку. Бывает, что кто то мне кидает текст с опечаткой, которую с первого раза не заметишь, а если набор текста идёт "слепым" способом, то количество опечаток увеличивается в разы!
Ладно, если место опечатки комментарий к коду, классу, методу или свойству, но это может быть подпись к форме, которая может остаться незамеченной и оказаться на виду у заказчика. И, честно говоря, за такое бывает стыдно!
Напоследок CodeReview - это то, из-за чего я вообще начал искать, как проверять ошибки до заливания на проверку кода. А дело тут вот в чём... При проверке кода, к которому обязательно требовалось добавлять комментарий ко всему, чему только можно - у меня и коллег уходило много времени на прочтение и проверку каждого написанного предложения. Я сидел и по слогам читал слова, что бы не пропустить ошибку. Доходило до того, что меня это изматывало больше, чем анализ написанного кода.
Поэтому для меня остро встал вопрос: Как же осуществить проверку орфографии в Visual Studio? 

Решение было найдено! Им оказалась установка обычного расширения, которое, немаловажно, умело проверять русский, английский и многие другие языки, а так же было полностью бесплатным.

Его название и ссылка на https://marketplace.visualstudio.com:
Visual Studio Spell Checker (VS2013/VS2015)

10 ноября 2017 г.

Как создать XML и XSD схему и наоборот

Хотелось бы в одном месте рассказать о вполне типичной задаче при работе с XML, а именно, о создании XML на основе существующего. Данная операция будет состоять из нескольких этапов, при выполнении которых, будут решены дополнительные задачи, такие как:
  • Создание XML на основе XSD, и наоборот.
  • Сериализация и десериализация объектов.
  • Создание класса, для будущей сериализации из XML или XSD.
Перед началом планирую, что читатель знаком со словами XML и XSD. Что касается XML, думаю с этим проблем нет, но что касается XSD могу возникнут вопросы, что же это такое. Если коротко, то:
XSD - это язык, для описания XML. И если вы посмотрите содержимое файла содержащего это описание, то возникнет вопрос, зачем же описывать казалось бы очевидные теги вашего XML? Но представьте, что вы интегрируетесь с какой то внешней системой, и для обмена данных хотите использовать формат XML. Так вот, XSD позволяет описать для каждого элемента его именя, возможные атрибуты, обязательность полей или атрибутов, дать понять, что содержимое какого то тега может содержать лишь один внутренний элемент (<a></b></a>) и не более, либо узел может иметь последовательность элементов (<a></b></b>...</a>). Когда внешняя система является вашей, тогда проблем может не возникнуть, но когда это сторонняя организация, тогда данное описание через XSD, будет инструментом урегулирования споров с форматом, а так же, используя утилиты, можно проверить соответствие любой XML изначальному формату.
Итак, что же мы будем делать, для того, что бы научиться штамповать XML на основе вашего эталона? Опишу всё по порядку.

Имеется: 
Какой то XML (xmlfile.xml), сохраненный в текстовом формате в файл. Ниже приведу текст:

<?xml version="1.0"?>
<catalog>
   <book id="bk101">
      <author>Gambardella, Matthew</author>
      <title>XML Developer's Guide</title>
      <genre>Computer</genre>
      <price>44.95</price>
      <publish_date>2000-10-01</publish_date>
      <description>An in-depth look at creating applications 
      with XML.</description>
   </book>
   <book id="bk102">
      <author>Ralls, Kim</author>
      <title>Midnight Rain</title>
      <genre>Fantasy</genre>
      <price>5.95</price>
      <publish_date>2000-12-16</publish_date>
      <description>A former architect battles corporate zombies, 
      an evil sorceress, and her own childhood to become queen 
      of the world.</description>
   </book>
</catalog>

23 октября 2017 г.

Msbuild debugging. Отладка csproj скрипта проекта в Visual Studio.

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

Но выход есть! Скрипт MsBuild можно отлаживать, ставить breakpoints и смотреть значения переменных. Приведу ссылку на исходную статью Debugging MSBuild script with Visual Studio а тут опишу действия на примере Visual Studio 2015 и некоторые особенности.

Сборку и отладку придется запускать через командную строку msbuild.exe используя опцию /debug, но изначально данная функция не доступна, поэтому при попытке воспользоваться ключом будет ошибка:

D:\!Blog\DebugFeatures\DebugFeatures>C:\Windows\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe /debug DebugFeatures.csproj
Microsoft (R) Build Engine version 4.6.1055.0
[Microsoft .NET Framework, version 4.0.30319.42000]
Copyright (C) Microsoft Corporation. All rights reserved.

MSBUILD : error MSB1001: Unknown switch.
Switch: /debug

For switch syntax, type "MSBuild /help"

Поэтому потребуется:
  • Сначала нужно добавить в ветку реестра HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSBuild\4.0 значение DebuggerEnabled = true. На компьютере могут стаять две версии .NET Framework - под x64 и x86 поэтому для обоих свои ветки реестра. В статье выше указан путь только к одной ветке, поэтому я приведу текст написанного мной скрипта, который добавит это значение в оба места.

    SET FrameworkDir=%windir%\Microsoft.NET\Framework
    SET FrameworkDir64=%windir%\Microsoft.NET\Framework64
     
    SET Cmd32Exe=%windir%\System32\cmd.exe
    SET Cmd64Exe=%windir%\SysWOW64\cmd64.exe
     
    IF EXIST %FrameworkDir% (
     start %Cmd32Exe% /c "reg add "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSBuild\4.0" /v DebuggerEnabled /d true"
    ) 
     
    IF EXIST %FrameworkDir64% (
     start %Cmd64Exe% /c "reg add "HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\MSBuild\4.0" /v DebuggerEnabled /d true"
    )
    
    Для запуска скопируйте в блокнот, сохраните как AnyName.bat, затем запустите.
    
  • Затем идём в студию, выбираем проект и в контекстном меню выбираем пункт "Unload Project", проект должен стать "Недоступным":

  • Далее для запуска отладчика пишем в командной строке "Путь\msbuild.exe" /debug "Путь\MyProject.csproj", запускаем и должны увидеть: