{"id":1183,"date":"2019-10-08T09:09:35","date_gmt":"2019-10-08T09:09:35","guid":{"rendered":"https:\/\/docs.sisus.co\/power-inspector\/?p=1183"},"modified":"2019-10-08T09:23:09","modified_gmt":"2019-10-08T09:23:09","slug":"create-script-wizard-add-comments-as-summary","status":"publish","type":"post","link":"https:\/\/docs.sisus.co\/power-inspector\/preferences\/create-script-wizard-add-comments-as-summary\/","title":{"rendered":"Create Script Wizard: Add Comments As Summary"},"content":{"rendered":"<p>Determines whether or not comments that area placed above method definitions when creating script assets using the <a href=\"https:\/\/docs.sisus.co\/power-inspector\/features\/create-script-wizard\/\">Create Script Wizard<\/a> should be added as <a href=\"https:\/\/docs.microsoft.com\/en-us\/dotnet\/csharp\/codedoc\">XML documentation comments<\/a> with the summary tag.<\/p>\n<h3>True (Default)<\/h3>\n<blockquote><p>Comments above method definitions will be added as XML documentation comments with triple forward slashes (<strong>\/\/\/<\/strong>) and wrapped inside a summary tag.<\/p>\n<p><strong><br \/>\nExample:<\/strong><\/p>\n<p><span style=\"color: #339966;\"><span class=\"hljs-comment\"><span class=\"hljs-doctag\">\/\/\/<\/span> <span class=\"hljs-doctag\">&lt;summary&gt;<br \/>\n<\/span><\/span><span class=\"hljs-comment\"><span class=\"hljs-doctag\">\/\/\/<\/span> This is an example summary.<br \/>\n<\/span><\/span><span class=\"hljs-comment\"><span class=\"hljs-doctag\" style=\"color: #339966;\">\/\/\/ <\/span><span class=\"hljs-doctag\"><span style=\"color: #339966;\">&lt;\/summary&gt;<\/span><br \/>\n<\/span><\/span><strong><span style=\"color: #3366ff;\">void<\/span> ExampleMethod()<\/strong> { }<\/p><\/blockquote>\n<h3>False<\/h3>\n<blockquote><p>Comments above method definitions will be added as simple comments with double forward slashes (<strong>\/\/<\/strong>).<\/p>\n<p><strong><br \/>\nExample:<\/strong><\/p>\n<p><span class=\"hljs-comment\"><span style=\"color: #339966;\"><span class=\"hljs-doctag\">\/\/<\/span> This is an example simple comment.<\/span><br \/>\n<\/span><strong><span style=\"color: #3366ff;\">void<\/span> ExampleMethod()<\/strong> { }<\/p><\/blockquote>\n<p><strong>See Also:<\/strong><br \/>\n<a href=\"https:\/\/docs.sisus.co\/power-inspector\/preferences\/create-script-wizard-add-comments\/\">Create Script Wizard: Add Comments<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Determines whether or not comments that area placed above method definitions when creating script assets using the Create Script Wizard should be added as XML documentation comments with the summary tag. True (Default) Comments above method definitions will be added as XML documentation comments with triple forward slashes (\/\/\/) and wrapped inside a summary tag. ..<\/p>\n<div class=\"clear-fix\"><\/div>\n<p><a href=\"https:\/\/docs.sisus.co\/power-inspector\/preferences\/create-script-wizard-add-comments-as-summary\/\" title=\"read more\">Read more<\/a><\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[6],"tags":[],"_links":{"self":[{"href":"https:\/\/docs.sisus.co\/power-inspector\/wp-json\/wp\/v2\/posts\/1183"}],"collection":[{"href":"https:\/\/docs.sisus.co\/power-inspector\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.sisus.co\/power-inspector\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.sisus.co\/power-inspector\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.sisus.co\/power-inspector\/wp-json\/wp\/v2\/comments?post=1183"}],"version-history":[{"count":9,"href":"https:\/\/docs.sisus.co\/power-inspector\/wp-json\/wp\/v2\/posts\/1183\/revisions"}],"predecessor-version":[{"id":1192,"href":"https:\/\/docs.sisus.co\/power-inspector\/wp-json\/wp\/v2\/posts\/1183\/revisions\/1192"}],"wp:attachment":[{"href":"https:\/\/docs.sisus.co\/power-inspector\/wp-json\/wp\/v2\/media?parent=1183"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.sisus.co\/power-inspector\/wp-json\/wp\/v2\/categories?post=1183"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.sisus.co\/power-inspector\/wp-json\/wp\/v2\/tags?post=1183"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}