{"id":7142,"date":"2017-05-16T00:28:30","date_gmt":"2017-05-16T05:28:30","guid":{"rendered":"https:\/\/daedtech.wpenginepowered.com\/?p=7142"},"modified":"2017-05-16T00:28:32","modified_gmt":"2017-05-16T05:28:32","slug":"customizing-generated-method-header-comments","status":"publish","type":"post","link":"https:\/\/daedtech.com\/customizing-generated-method-header-comments\/","title":{"rendered":"Customizing Generated Method Header Comments"},"content":{"rendered":"

Editorial note: I originally wrote this post for the SubMain blog. \u00a0You can check out the original here, at their site<\/a>. \u00a0While you’re there, have a look at GhostDoc, the subject of this post.<\/em><\/p>\n

Last month, I wrote a post introducing you to T4 templates<\/a>. \u00a0Near the end, I included a mention of GhostDoc’s use of T4 templates in automatically generating code comments. \u00a0Today, I’d like to expand on that.<\/p>\n

To recap very briefly, recall that Ghost Doc allows you to generate things like method header comments. \u00a0I recommend that, in most cases, you let it do its thing. \u00a0It does a good job. \u00a0But sometimes, you might have occasion to want to tweak the result. \u00a0And you can do that by making use of T4 Templates.<\/p>\n

Documenting Chess TDD<\/h3>\n

\"\"<\/a><\/p>\n

To demonstrate, let’s revisit my trusty toy code base, Chess TDD<\/a>. \u00a0Because I put this code together for instructional purposes and not to release as a product, it has no method header comments for Intellisense’s benefit. \u00a0This makes it the perfect candidate for a demonstration.<\/p>\n

If I had released this as a library, I’d have started the documentation with the Board class. \u00a0Most of the client interaction would happen via Board, so let’s document that. \u00a0It offers you a constructor and a bunch of semantics around placing and moving pieces. \u00a0Let’s document the conceptually simple “MovePiece” method.<\/p>\n

<\/p>\n

public void MovePiece(BoardCoordinate origin, BoardCoordinate destination)\r\n{\r\n    VerifyCoordinatesOrThrow(origin, destination);\r\n\r\n    var pieceToMove = GetPiece(origin);\r\n    AddPiece(pieceToMove, destination);\r\n    RemovePiece(origin);\r\n    pieceToMove.HasMoved = true;\r\n\r\n    ReconcileEnPassant(origin, destination, pieceToMove);\r\n}<\/pre>\n
To add documentation to this method, I simply right click it and, from the GhostDoc context menu, select “Document This.” \u00a0Alternatively, I can use the keyboard shortcut Ctrl-Shift-D. \u00a0Either option yields the following result.<\/p>\n
\/\/\/ <summary>\r\n\/\/\/ Moves the piece.\r\n\/\/\/ <\/summary>\r\n\/\/\/ <param name=\"origin\">The origin.<\/param>\r\n\/\/\/ <param name=\"destination\">The destination.<\/param>\r\npublic void MovePiece(BoardCoordinate origin, BoardCoordinate destination)\r\n{\r\n    VerifyCoordinatesOrThrow(origin, destination);\r\n\r\n    var pieceToMove = GetPiece(origin);\r\n    AddPiece(pieceToMove, destination);\r\n    RemovePiece(origin);\r\n    pieceToMove.HasMoved = true;\r\n\r\n    ReconcileEnPassant(origin, destination, pieceToMove);\r\n}<\/pre>\n
Let’s Make a Tiny Tweak<\/h3>\n
Alright,\u00a0much better! \u00a0If I scrutinize the comment, I can imagine what an intellisense-using client will see. \u00a0My parameter naming makes this conceptually simple to understand, so the intellisense will tell the user that the first parameter represents the origin square and the second parameter the destination.<\/p>\n
But let’s say that as I look at this, I find myself wanting to pick at a nit. \u00a0I don’t care for the summary taking up three lines — I want to condense it to one. \u00a0How might I do that?<\/p>\n
Well, let’s crack open the T4 template for generating a method header. \u00a0Recall that you do this in Visual Studio by selecting Tools->Ghost Doc->Options, and picking “Rules” from the options pane.<\/p>\n
\"\"<\/a><\/p>\n
If you double click on “Method Template”, as highlighted above, you will see an “Edit Rule” Window. \u00a0The first few lines of code in that window look like this.<\/p>\n
<#@ template language=\"C#\" #>\r\n<#  CodeElement codeElement = Context.CurrentCodeElement; #>\r\n\/\/\/ <summary>\r\n\/\/\/<# GenerateSummaryText(); #>\r\n\/\/\/ <\/summary>\r\n<#\tif(codeElement.HasTypeParameters) \r\n\t{\r\n\t\tfor(int i = 0; i < codeElement.TypeParameters.Length; i++) \r\n\t\t{ \r\n\t\t\tTypeParameter typeParameter = codeElement.TypeParameters[i]; \r\n#><\/pre>\n
Hmmm. \u00a0I cannot count myself an expert in T4 templates, per se,\u00a0<\/em>but I think I have an idea. \u00a0Let’s put that call to GenerateSummaryText() inline between the summary tags. \u00a0Like this.<\/p>\n
<#@ template language=\"C#\" #>\r\n<#  CodeElement codeElement = Context.CurrentCodeElement; #>\r\n\/\/\/ <summary><# GenerateSummaryText(); #><\/summary><\/pre>\n
That should do it, right? \u00a0Let’s regenerate the comment and see what it looks like. \u00a0This results in the following.<\/p>\n
\/\/\/ <summary>Moves the piece.\r\n\/\/\/ <\/summary>\r\n\/\/\/ <param name=\"origin\">The origin.<\/param>\r\n\/\/\/ <param name=\"destination\">The destination.<\/param>\r\npublic void MovePiece(BoardCoordinate origin, BoardCoordinate destination)\r\n{\r\n    VerifyCoordinatesOrThrow(origin, destination);\r\n\r\n    var pieceToMove = GetPiece(origin);\r\n    AddPiece(pieceToMove, destination);\r\n    RemovePiece(origin);\r\n    pieceToMove.HasMoved = true;\r\n\r\n    ReconcileEnPassant(origin, destination, pieceToMove);\r\n}<\/pre>\n
Uh, oh. \u00a0It made a difference, but somehow we only got halfway there. \u00a0Why might that be?<\/p>\n
Diving Deeper<\/h3>\n
To understand, we need to look at the template in a bit more detail. \u00a0The template itself has everything on one line, and yet we see a newline in there somehow. \u00a0Could GenerateTextSummary cause this, somehow? \u00a0Let’s scroll down to look at it. \u00a0Since this method has a lot of code, here are the first few lines only.<\/p>\n
private void GenerateSummaryText()\r\n{\r\n\tif(Context.HasExistingTagText(\"summary\"))\r\n\t{\r\n\t\tthis.WriteLine(Context.GetExistingTagText(\"summary\"));\r\n\t}\r\n\telse if(IsAsyncMethod())\r\n\t{\r\n\t\tthis.WriteLine(Context.ExecMacro(\"$(MethodName.Words.ExceptLast)\") + \" as an asynchronous operation.\");\r\n\t}\r\n\telse if(IsMainMethod())\r\n\t{\r\n\t\tthis.WriteLine(\"Defines the entry point of the application.\");        \r\n\t}\r\n<\/pre>\n
Aha! \u00a0Notice that we’re calling WriteLine.<\/span> \u00a0What if we did a find and replace to change all of those to just Write? \u00a0Let’s try. \u00a0(To do more serious operations like this, you will want to copy the text out of the editor and into your favorite text editor in order to get more operations).<\/p>\n
Once you have replaced all instances of WriteLine with Write in the template, here is the new result.<\/p>\n
\/\/\/ <summary>Moves the piece.<\/summary>\r\n\/\/\/ <param name=\"origin\">The origin.<\/param>\r\n\/\/\/ <param name=\"destination\">The destination.<\/param>\r\npublic void MovePiece(BoardCoordinate origin, BoardCoordinate destination)\r\n{\r\n    VerifyCoordinatesOrThrow(origin, destination);\r\n\r\n    var pieceToMove = GetPiece(origin);\r\n    AddPiece(pieceToMove, destination);\r\n    RemovePiece(origin);\r\n    pieceToMove.HasMoved = true;\r\n\r\n    ReconcileEnPassant(origin, destination, pieceToMove);\r\n}<\/pre>\n
Success!<\/p>\n
Validation<\/h3>\n
As you play with this, you might have noticed a “validate” button in the rule editor. \u00a0Use this liberally! \u00a0This button will trigger a parsing of the template and provide you with feedback as to validity. \u00a0The last thing you want to do is work in here for many iterations and wind up with no idea what you broke and when.<\/p>\n
When working with these templates, think of this as equivalent to compiling. \u00a0You wouldn’t want to sit for 20 minutes writing code with no feedback as to whether it builds or not. \u00a0So don’t do it with these templates.<\/p>\n
The Power at Your Disposal<\/h3>\n
I’ll wrap here for this particular lesson, but understand that we have barely scratched the surface of what you can do. \u00a0In this post, we just changed a bit of the formatting to suit a whim I had. \u00a0But you can really dive into ways of reasoning about and documenting the code if you so choose.<\/p>\n
Stay tuned for future posts on more advanced tips and tricks with your comment templates.<\/p>\n","protected":false},"excerpt":{"rendered":"
Editorial note: I originally wrote this post for the SubMain blog. \u00a0You can check out the original here, at their site. \u00a0While you’re there, have a look at GhostDoc, the subject of this post. Last month, I wrote a post introducing you to T4 templates. \u00a0Near the end, I included a mention of GhostDoc’s use…<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"_kad_post_classname":"","footnotes":""},"categories":[67],"tags":[10,155,219,216],"class_list":["post-7142","post","type-post","status-publish","format-standard","hentry","category-net","tag-c","tag-chesstdd","tag-ghostdoc","tag-submain"],"yoast_head":"\nCustomizing Generated Method Header Comments - DaedTech<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:title\" content=\"Customizing Generated Method Header Comments - DaedTech\" \/>\n<meta name=\"twitter:description\" content=\"Editorial note: I originally wrote this post for the SubMain blog. \u00a0You can check out the original here, at their site. \u00a0While you’re there, have a look at GhostDoc, the subject of this post. Last month, I wrote a post introducing you to T4 templates. \u00a0Near the end, I included a mention of GhostDoc’s use...\" \/>\n<meta name=\"twitter:image\" content=\"https:\/\/daedtech.com\/wp-content\/uploads\/2016\/02\/HighFiveChess.png\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Erik Dietrich\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"http:\\\/\\\/community.submain.com\\\/blogs\\\/submain\\\/archive\\\/2017\\\/01\\\/03\\\/ghostdoc-customizing-generated-method-header-comments.aspx#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/daedtech.com\\\/customizing-generated-method-header-comments\\\/\"},\"author\":{\"name\":\"Erik Dietrich\",\"@id\":\"https:\\\/\\\/daedtech.com\\\/#\\\/schema\\\/person\\\/3dae63e91a0fa60c8051a2171fa687d2\"},\"headline\":\"Customizing Generated Method Header Comments\",\"datePublished\":\"2017-05-16T05:28:30+00:00\",\"dateModified\":\"2017-05-16T05:28:32+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/daedtech.com\\\/customizing-generated-method-header-comments\\\/\"},\"wordCount\":821,\"commentCount\":2,\"publisher\":{\"@id\":\"https:\\\/\\\/daedtech.com\\\/#organization\"},\"image\":{\"@id\":\"http:\\\/\\\/community.submain.com\\\/blogs\\\/submain\\\/archive\\\/2017\\\/01\\\/03\\\/ghostdoc-customizing-generated-method-header-comments.aspx#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/daedtech.com\\\/wp-content\\\/uploads\\\/2016\\\/02\\\/HighFiveChess.png\",\"keywords\":[\"C#\",\"ChessTDD\",\"GhostDoc\",\"SubMain\"],\"articleSection\":[\".NET\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"http:\\\/\\\/community.submain.com\\\/blogs\\\/submain\\\/archive\\\/2017\\\/01\\\/03\\\/ghostdoc-customizing-generated-method-header-comments.aspx#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/daedtech.com\\\/customizing-generated-method-header-comments\\\/\",\"url\":\"http:\\\/\\\/community.submain.com\\\/blogs\\\/submain\\\/archive\\\/2017\\\/01\\\/03\\\/ghostdoc-customizing-generated-method-header-comments.aspx\",\"name\":\"Customizing Generated Method Header Comments - DaedTech\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/daedtech.com\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"http:\\\/\\\/community.submain.com\\\/blogs\\\/submain\\\/archive\\\/2017\\\/01\\\/03\\\/ghostdoc-customizing-generated-method-header-comments.aspx#primaryimage\"},\"image\":{\"@id\":\"http:\\\/\\\/community.submain.com\\\/blogs\\\/submain\\\/archive\\\/2017\\\/01\\\/03\\\/ghostdoc-customizing-generated-method-header-comments.aspx#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/daedtech.com\\\/wp-content\\\/uploads\\\/2016\\\/02\\\/HighFiveChess.png\",\"datePublished\":\"2017-05-16T05:28:30+00:00\",\"dateModified\":\"2017-05-16T05:28:32+00:00\",\"breadcrumb\":{\"@id\":\"http:\\\/\\\/community.submain.com\\\/blogs\\\/submain\\\/archive\\\/2017\\\/01\\\/03\\\/ghostdoc-customizing-generated-method-header-comments.aspx#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"http:\\\/\\\/community.submain.com\\\/blogs\\\/submain\\\/archive\\\/2017\\\/01\\\/03\\\/ghostdoc-customizing-generated-method-header-comments.aspx\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"http:\\\/\\\/community.submain.com\\\/blogs\\\/submain\\\/archive\\\/2017\\\/01\\\/03\\\/ghostdoc-customizing-generated-method-header-comments.aspx#primaryimage\",\"url\":\"https:\\\/\\\/daedtech.com\\\/wp-content\\\/uploads\\\/2016\\\/02\\\/HighFiveChess.png\",\"contentUrl\":\"https:\\\/\\\/daedtech.com\\\/wp-content\\\/uploads\\\/2016\\\/02\\\/HighFiveChess.png\",\"width\":1440,\"height\":960},{\"@type\":\"BreadcrumbList\",\"@id\":\"http:\\\/\\\/community.submain.com\\\/blogs\\\/submain\\\/archive\\\/2017\\\/01\\\/03\\\/ghostdoc-customizing-generated-method-header-comments.aspx#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/daedtech.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customizing Generated Method Header Comments\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/daedtech.com\\\/#website\",\"url\":\"https:\\\/\\\/daedtech.com\\\/\",\"name\":\"DaedTech\",\"description\":\"Stories about Software\",\"publisher\":{\"@id\":\"https:\\\/\\\/daedtech.com\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/daedtech.com\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/daedtech.com\\\/#organization\",\"name\":\"DaedTech LLC\",\"url\":\"https:\\\/\\\/daedtech.com\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/daedtech.com\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/daedtech.com\\\/wp-content\\\/uploads\\\/2015\\\/07\\\/SmallLogo.jpg\",\"contentUrl\":\"https:\\\/\\\/daedtech.com\\\/wp-content\\\/uploads\\\/2015\\\/07\\\/SmallLogo.jpg\",\"width\":82,\"height\":84,\"caption\":\"DaedTech LLC\"},\"image\":{\"@id\":\"https:\\\/\\\/daedtech.com\\\/#\\\/schema\\\/logo\\\/image\\\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/daedtech.com\\\/#\\\/schema\\\/person\\\/3dae63e91a0fa60c8051a2171fa687d2\",\"name\":\"Erik Dietrich\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/691ca004bd18f464e9467b2f838e8fbc7a9a2c9eb8568b04a834ac653f3ab1d7?s=96&d=wavatar&r=pg\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/691ca004bd18f464e9467b2f838e8fbc7a9a2c9eb8568b04a834ac653f3ab1d7?s=96&d=wavatar&r=pg\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/691ca004bd18f464e9467b2f838e8fbc7a9a2c9eb8568b04a834ac653f3ab1d7?s=96&d=wavatar&r=pg\",\"caption\":\"Erik Dietrich\"},\"sameAs\":[\"https:\\\/\\\/daedtech.com\"],\"url\":\"https:\\\/\\\/daedtech.com\\\/author\\\/erik\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Customizing Generated Method Header Comments - DaedTech","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx","twitter_card":"summary_large_image","twitter_title":"Customizing Generated Method Header Comments - DaedTech","twitter_description":"Editorial note: I originally wrote this post for the SubMain blog. \u00a0You can check out the original here, at their site. \u00a0While you’re there, have a look at GhostDoc, the subject of this post. Last month, I wrote a post introducing you to T4 templates. \u00a0Near the end, I included a mention of GhostDoc’s use...","twitter_image":"https:\/\/daedtech.com\/wp-content\/uploads\/2016\/02\/HighFiveChess.png","twitter_misc":{"Written by":"Erik Dietrich","Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx#article","isPartOf":{"@id":"https:\/\/daedtech.com\/customizing-generated-method-header-comments\/"},"author":{"name":"Erik Dietrich","@id":"https:\/\/daedtech.com\/#\/schema\/person\/3dae63e91a0fa60c8051a2171fa687d2"},"headline":"Customizing Generated Method Header Comments","datePublished":"2017-05-16T05:28:30+00:00","dateModified":"2017-05-16T05:28:32+00:00","mainEntityOfPage":{"@id":"https:\/\/daedtech.com\/customizing-generated-method-header-comments\/"},"wordCount":821,"commentCount":2,"publisher":{"@id":"https:\/\/daedtech.com\/#organization"},"image":{"@id":"http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx#primaryimage"},"thumbnailUrl":"https:\/\/daedtech.com\/wp-content\/uploads\/2016\/02\/HighFiveChess.png","keywords":["C#","ChessTDD","GhostDoc","SubMain"],"articleSection":[".NET"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx#respond"]}]},{"@type":"WebPage","@id":"https:\/\/daedtech.com\/customizing-generated-method-header-comments\/","url":"http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx","name":"Customizing Generated Method Header Comments - DaedTech","isPartOf":{"@id":"https:\/\/daedtech.com\/#website"},"primaryImageOfPage":{"@id":"http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx#primaryimage"},"image":{"@id":"http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx#primaryimage"},"thumbnailUrl":"https:\/\/daedtech.com\/wp-content\/uploads\/2016\/02\/HighFiveChess.png","datePublished":"2017-05-16T05:28:30+00:00","dateModified":"2017-05-16T05:28:32+00:00","breadcrumb":{"@id":"http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx#primaryimage","url":"https:\/\/daedtech.com\/wp-content\/uploads\/2016\/02\/HighFiveChess.png","contentUrl":"https:\/\/daedtech.com\/wp-content\/uploads\/2016\/02\/HighFiveChess.png","width":1440,"height":960},{"@type":"BreadcrumbList","@id":"http:\/\/community.submain.com\/blogs\/submain\/archive\/2017\/01\/03\/ghostdoc-customizing-generated-method-header-comments.aspx#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/daedtech.com\/"},{"@type":"ListItem","position":2,"name":"Customizing Generated Method Header Comments"}]},{"@type":"WebSite","@id":"https:\/\/daedtech.com\/#website","url":"https:\/\/daedtech.com\/","name":"DaedTech","description":"Stories about Software","publisher":{"@id":"https:\/\/daedtech.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/daedtech.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/daedtech.com\/#organization","name":"DaedTech LLC","url":"https:\/\/daedtech.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/daedtech.com\/#\/schema\/logo\/image\/","url":"https:\/\/daedtech.com\/wp-content\/uploads\/2015\/07\/SmallLogo.jpg","contentUrl":"https:\/\/daedtech.com\/wp-content\/uploads\/2015\/07\/SmallLogo.jpg","width":82,"height":84,"caption":"DaedTech LLC"},"image":{"@id":"https:\/\/daedtech.com\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/daedtech.com\/#\/schema\/person\/3dae63e91a0fa60c8051a2171fa687d2","name":"Erik Dietrich","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/691ca004bd18f464e9467b2f838e8fbc7a9a2c9eb8568b04a834ac653f3ab1d7?s=96&d=wavatar&r=pg","url":"https:\/\/secure.gravatar.com\/avatar\/691ca004bd18f464e9467b2f838e8fbc7a9a2c9eb8568b04a834ac653f3ab1d7?s=96&d=wavatar&r=pg","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/691ca004bd18f464e9467b2f838e8fbc7a9a2c9eb8568b04a834ac653f3ab1d7?s=96&d=wavatar&r=pg","caption":"Erik Dietrich"},"sameAs":["https:\/\/daedtech.com"],"url":"https:\/\/daedtech.com\/author\/erik\/"}]}},"_links":{"self":[{"href":"https:\/\/daedtech.com\/wp-json\/wp\/v2\/posts\/7142","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/daedtech.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/daedtech.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/daedtech.com\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/daedtech.com\/wp-json\/wp\/v2\/comments?post=7142"}],"version-history":[{"count":0,"href":"https:\/\/daedtech.com\/wp-json\/wp\/v2\/posts\/7142\/revisions"}],"wp:attachment":[{"href":"https:\/\/daedtech.com\/wp-json\/wp\/v2\/media?parent=7142"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/daedtech.com\/wp-json\/wp\/v2\/categories?post=7142"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/daedtech.com\/wp-json\/wp\/v2\/tags?post=7142"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}