Fancy comments, part 2

Started implementing the fancy formatter.  It currently doesn't do
anything fancy, just word-wrapping.

Moved the static DebugShowRuler field into Formatter, so that the
cached data is discarded when the setting changes.

Also, updated SourceNotes with instructions for publishing a release.

Asm65/Formatter.cs

@@ -72,6 +72,8 @@ public class FormatConfig {
 
             /// <summary>Insert space after delimiter for long comments?</summary>
             public bool AddSpaceLongComment { get; set; } = false;
+            /// <summary>Enable debug mode for long comments?</summary>
+            public bool DebugLongComments { get; set; } = false;
 
             //
             // Functional changes to assembly output.
@@ -163,6 +165,7 @@ public FormatConfig(FormatConfig src) {
                 UpperOperandXY = src.UpperOperandXY;
 
                 AddSpaceLongComment = src.AddSpaceLongComment;
+                DebugLongComments = src.DebugLongComments;
 
                 SuppressHexNotation = src.SuppressHexNotation;
                 SuppressImpliedAcc = src.SuppressImpliedAcc;
@@ -539,6 +542,13 @@ public string FullLineCommentDelimiterPlus {
             get { return mFullLineCommentDelimiterPlus; }
         }
 
+        /// <summary>
+        /// If true, enable debug mode when rendering long comments.
+        /// </summary>
+        public bool DebugLongComments {
+            get { return mFormatConfig.DebugLongComments; }
+        }
+
         /// <summary>
         /// Prefix for non-unique address labels.
         /// </summary>
@@ -565,15 +575,17 @@ public int OperandWrapLen {
 
         /// <summary>
         /// Constructor.  Initializes various fields based on the configuration.  We want to
-        /// do as much work as possible here.
+        /// pre-compute as many things as possible, to speed up formatting.
         /// </summary>
         public Formatter(FormatConfig config) {
             mFormatConfig = new FormatConfig(config);       // make a copy
 
             if (string.IsNullOrEmpty(mFormatConfig.NonUniqueLabelPrefix)) {
                 mFormatConfig.NonUniqueLabelPrefix = "@";
             }
-
+            if (string.IsNullOrEmpty(mFormatConfig.FullLineCommentDelimiterBase)) {
+                mFormatConfig.FullLineCommentDelimiterBase = "!";
+            }
             if (mFormatConfig.AddSpaceLongComment) {
                 mFullLineCommentDelimiterPlus = mFormatConfig.FullLineCommentDelimiterBase + " ";
             } else {

SourceGen/MainController.cs

@@ -500,6 +500,7 @@ public void ApplyAppSettings() {
                 settings.GetString(AppSettings.FMT_LOCAL_VARIABLE_PREFIX, string.Empty);
             mFormatterConfig.CommaSeparatedDense =
                 settings.GetBool(AppSettings.FMT_COMMA_SEP_BULK_DATA, true);
+            mFormatterConfig.DebugLongComments = DebugLongComments;
 
             string chrDelCereal = settings.GetString(AppSettings.FMT_CHAR_DELIM, null);
             if (chrDelCereal != null) {
@@ -4721,6 +4722,11 @@ public void ViewAddressMap() {
 
         #region Debug features
 
+        /// <summary>
+        /// If set, show rulers and visible spaces in long comments.
+        /// </summary>
+        internal bool DebugLongComments { get; private set; } = false;
+
         public void Debug_ExtensionScriptInfo() {
             string info = mProject.DebugGetLoadedScriptInfo();
 
@@ -4793,12 +4799,15 @@ public void Debug_Refresh() {
         }
 
         public void Debug_ToggleCommentRulers() {
-            MultiLineComment.DebugShowRuler = !MultiLineComment.DebugShowRuler;
-            // Don't need to repeat the analysis, but we do want to save/restore the
-            // selection and top position when the comment fields change size.
-            UndoableChange uc =
-                UndoableChange.CreateDummyChange(UndoableChange.ReanalysisScope.DataOnly);
-            ApplyChanges(new ChangeSet(uc), false);
+            DebugLongComments = !DebugLongComments;
+            mFormatterConfig.DebugLongComments = DebugLongComments;
+            mFormatterConfig.AddSpaceLongComment = !DebugLongComments;
+            mFormatterCpuDef = null;        // force mFormatter refresh on next analysis
+            if (CodeLineList != null) {
+                UndoableChange uc =
+                    UndoableChange.CreateDummyChange(UndoableChange.ReanalysisScope.DisplayOnly);
+                ApplyChanges(new ChangeSet(uc), false);
+            }
         }
 
         public void Debug_ToggleKeepAliveHack() {