保哥線上講堂:利用 StyleCop 撰寫一致的 C# 程式碼風格

6,920 views

Published on

本次講座 Will 保哥將分享如何透過 Visual Studio 的 StyleCop 擴充套件做到全自動的程式碼撰寫風格檢查,讓每個人都不用看規範文件,透過工具用最無腦的方式自動幫你做好到程式碼風格檢查。如要觀看完整講座內容,可報名線上課程進行一步查看實際展示與技術講解,網址:
http://miniasp.kktix.cc/events/stylecop-in-action-online

Published in: Technology
0 Comments
31 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
6,920
On SlideShare
0
From Embeds
0
Number of Embeds
169
Actions
Shares
0
Downloads
0
Comments
0
Likes
31
Embeds 0
No embeds

No notes for slide

保哥線上講堂:利用 StyleCop 撰寫一致的 C# 程式碼風格

  1. 1. 1 保哥線上講堂 (1) 多奇數位創意有限公司 技術總監 黃保翕 ( Will 保哥 ) 部落格:http://blog.miniasp.com/ 利用 StyleCop 撰寫一致的 C# 程式碼風格
  2. 2. All services from your imperative. 2 什麼是 STYLECOP What is StyleCop
  3. 3. All services from your imperative. 3 什麼是 StyleCop?  主要用途  檢查 C# 程式碼撰寫風格符合標準規範  StyleCop 本身建議的撰寫風格  Microsoft's .NET Framework Design Guidelines  注意事項  不支援 VB.NET 或其他語言  早期由微軟開發,April 2010 已開放原始碼  官方網站  http://www.stylecop.com/  https://twitter.com/stylecopdev
  4. 4. All services from your imperative. 4 StyleCop 相容性  支援 Visual Studio 版本  Visual Studio 2008  Visual Studio 2010  支援 JetBrains ReSharper (R#)  R# 5.1.3 ( 5.1.3000.12)  R# 6.0 (6.0.2202.688)  R# 6.1 (6.1.37.86)  R# 6.1.1 (6.1.1000.82)  Visual Studio 2012  Visual Studio 2013  R# 7.0.1 (7.0.1098.2760)  R# 7.1.3 (7.1.3000.2254)  R# 8.2 (8.2.0.2160)
  5. 5. All services from your imperative. 5 StyleCop 主要分析規則  區分七大類,共 165 條規則  Documentation (SA1600-) 有 51 條規則  Layout (SA1500-) 有 19 條規則  Maintainability (SA1400-) 有 13 條規則  Naming (SA1300-) 有 12 條規則  Ordering (SA1200-) 有 16 條規則  Readability (SA1100-) 有 26 條規則  Spacing (SA1000-) 有 28 條規則
  6. 6. All services from your imperative. 6 DEMO 示範 StyleCop 基本安裝與操作
  7. 7. All services from your imperative. 7 了解 STYLECOP 的規則如何定義 Settings.StyleCop
  8. 8. All services from your imperative. 8 幾種定義套用規則的方法  手動編輯 *.StyleCop 檔案  滑鼠雙擊 *.StyleCop 檔案  透過內建的 StyleCopSettingsEditor.exe 工具  StyleCopSettingsEditor.exe Settings.StyleCop  在特定類別、方法或參數跳過規則檢查  http://www.stylecop.com/docs/Suppressions.html
  9. 9. All services from your imperative. 9 DEMO 示範 StyleCop 如何定義要套用的規則
  10. 10. All services from your imperative. 10 如何跟 MSBUILD 組建流程整合 PM> Install-Package StyleCop.MSBuild
  11. 11. All services from your imperative. 11 安裝 NuGet 套件:StyleCop.MSBuild  NuGet Package  http://www.nuget.org/packages/StyleCop.MSBuild  PM> Install-Package StyleCop.MSBuild  stylecop-msbuild (Bitbucket)  https://bitbucket.org/adamralph/stylecop-msbuild  將 StyleCop 檢查失敗視為「錯誤」  用 Notepad 開啟專案檔 ( *.csproj )  在 <PropertyGroup> 加上以下 MSBuild 屬性設定 <StyleCopTreatErrorsAsWarnings>false</StyleCopTreatErrorsAsWarnings>
  12. 12. All services from your imperative. 12 DEMO 示範 StyleCop 如何跟 MSBuild 組建流程整合
  13. 13. All services from your imperative. 13 了解 STYLECOP 在實務上如何應用 StyleCop in Action
  14. 14. All services from your imperative. 14 StyleCop 使用經驗分享  找尋一個可靠的 Settings.StyleCop 定義檔  https://aspnetwebstack.codeplex.com/SourceControl/latest  透過一個既有的專案調校定義檔  選擇哪些是你不要的規則定義!  放置 Settings.StyleCop 在適當的地方  方案根目錄  專案根目錄  中文化 StyleCop 規則  翻譯的過程中了解每條規則的意義  整合 CI 建置流程 ( TFS / MSBuild )
  15. 15. All services from your imperative. 15 總結 Summary
  16. 16. All services from your imperative. 16 總結  StyleCop 是個必備工具  每個開發團隊都應該要有一份自己的規則集  適當的套用在開發流程與版控流程上 ( CI )  在公司內部分享 StyleCop 使用經驗
  17. 17. All services from your imperative. 17 StyleCop 相關資源  StyleCop 官網  http://www.stylecop.com/  StyleCop 4.7 線上文件 http://www.stylecop.com/docs/  StyleCop - Wikipedia, the free encyclopedia http://en.wikipedia.org/wiki/StyleCop  StyleCop CLI http://sourceforge.net/projects/stylecopcli/  StyleCop 的命令列工具版本  StyleCopCLI.exe -?
  18. 18. All services from your imperative. 18 聯絡資訊  The Will Will Web 記載著 Will 在網路世界的學習心得與技術分享  http://blog.miniasp.com/  Will 保哥的技術交流中心 (臉書粉絲專頁)  http://www.facebook.com/will.fans  ★ ★ ★ Will 保哥的噗浪 ★ ★ ★  http://www.plurk.com/willh/invite
  19. 19. All services from your imperative. 19 感謝各位

×