Microsoft/alguidelines
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

deploy: 9e06f72056

Browse source
This commit is contained in:
TheDoubleH 2022-02-11 17:30:04 +00:00
parent de09820554
commit e4f08bf9a7
187 changed files with 6620 additions and 6342 deletions
Download patch file Download diff file Expand all files Collapse all files

92
navpatterns/3-cal-coding-guidelines/readability/comments-curly-brackets/index.html
View file

@ -5,16 +5,16 @@
<meta name=generator content="Hugo 0.92.1">
<meta name=description content>
<title>Comments inside Curly Brackets :: AL Guidelines</title>
<link href=/css/nucleus.css?1644506470 rel=stylesheet>
<link href=/css/fontawesome-all.min.css?1644506470 rel=stylesheet>
<link href=/css/featherlight.min.css?1644506470 rel=stylesheet>
<link href=/css/perfect-scrollbar.min.css?1644506470 rel=stylesheet>
<link href=/css/auto-complete.css?1644506470 rel=stylesheet>
<link href=/css/theme.css?1644506470 rel=stylesheet>
<link href=/css/theme-blue.css?1644506470 rel=stylesheet>
<link href=/css/variant.css?1644506470 rel=stylesheet>
<link href=/css/print.css?1644506470 rel=stylesheet media=print>
<script src=/js/jquery.min.js?1644506470></script>
<link href=/css/nucleus.css?1644600600 rel=stylesheet>
<link href=/css/fontawesome-all.min.css?1644600600 rel=stylesheet>
<link href=/css/featherlight.min.css?1644600600 rel=stylesheet>
<link href=/css/perfect-scrollbar.min.css?1644600600 rel=stylesheet>
<link href=/css/auto-complete.css?1644600600 rel=stylesheet>
<link href=/css/theme.css?1644600600 rel=stylesheet>
<link href=/css/theme-blue.css?1644600600 rel=stylesheet>
<link href=/css/variant.css?1644600600 rel=stylesheet>
<link href=/css/print.css?1644600600 rel=stylesheet media=print>
<script src=/js/jquery.min.js?1644600600></script>
<style>:root #header+#content>#left>#rlblock_left{display:none!important}</style>
</head>
<body data-url=/navpatterns/3-cal-coding-guidelines/readability/comments-curly-brackets/>
@ -32,9 +32,9 @@ ALGuidelines.Dev
<input data-search-input id=search-by type=search placeholder=Search...>
<span data-search-clear><i class="fas fa-times"></i></span>
</div>
<script src=/js/lunr.min.js?1644506470></script>
<script src=/js/auto-complete.js?1644506470></script>
<script src=/js/search.js?1644506470></script>
<script src=/js/lunr.min.js?1644600600></script>
<script src=/js/auto-complete.js?1644600600></script>
<script src=/js/search.js?1644600600></script>
</div>
<div class=highlightable>
<ul class=topics>
@ -255,34 +255,32 @@ ALGuidelines.Dev
</div>
<main id=body-inner>
<h1>Comments inside Curly Brackets</h1>
<p>Never use curly bracket comments. During development, the &ldquo;Block comment&rdquo; functionality can be used instead. However, in production code, block comments are not recommended. Bad code</p>
<pre><code>PeriodTxt: {Period}
</code></pre>
<p>Good code</p>
<pre><code>PeriodTxt: // Period
</code></pre>
<p>Never use curly bracket comments. During development, the &ldquo;Block comment&rdquo; functionality can be used instead. However, in production code, block comments are not recommended.</p>
<p>Bad code</p>
<pre><code>PROCEDURE MATRIX\_OnAfterGetRecord@10(MATRIX\_ColumnOrdinal : Integer);
BEGIN
{
IF ShowColumnName THEN
MatrixHeader := MatrixRecords\[MATRIX\_ColumnOrdinal\].Name
ELSE
MatrixHeader := MatrixRecords\[MATRIX\_ColumnOrdinal\].Code;
}
MatrixRecord := MatrixRecords\[MATRIX\_ColumnOrdinal\];
AnalysisValue := CalcAmt(ValueType,TRUE);
MATRIX\_CellData\[MATRIX\_ColumnOrdinal\] := AnalysisValue;
END;
</code></pre>
<p>Good code</p>
<pre><code>PROCEDURE MATRIX\_OnAfterGetRecord@10(MATRIX\_ColumnOrdinal : Integer);
BEGIN
MatrixRecord := MatrixRecords\[MATRIX\_ColumnOrdinal\];
AnalysisValue := CalcAmt(ValueType,TRUE);
MATRIX\_CellData\[MATRIX\_ColumnOrdinal\] := AnalysisValue;
END;
</code></pre>
<div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-al data-lang=al>PeriodTxt: {Period}
</code></pre></div><p>Good code</p>
<div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-al data-lang=al>PeriodTxt: <span style=color:#75715e>// Period
</span></code></pre></div><p>Bad code</p>
<div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-al data-lang=al><span style=color:#66d9ef>PROCEDURE</span> MATRIX_OnAfterGetRecord@<span style=color:#ae81ff>10</span><span style=color:#f92672>(</span>MATRIX_ColumnOrdinal : <span style=color:#66d9ef>Integer</span><span style=color:#f92672>)</span>;
<span style=color:#66d9ef>BEGIN</span>
{
<span style=color:#66d9ef>IF</span> ShowColumnName <span style=color:#66d9ef>THEN</span>
MatrixHeader <span style=color:#f92672>:=</span> MatrixRecords[MATRIX_ColumnOrdinal]<span style=color:#f92672>.</span>Name
<span style=color:#66d9ef>ELSE</span>
MatrixHeader <span style=color:#f92672>:=</span> MatrixRecords[MATRIX_ColumnOrdinal]<span style=color:#f92672>.</span><span style=color:#66d9ef>Code</span>;
}
MatrixRecord <span style=color:#f92672>:=</span> MatrixRecords[MATRIX_ColumnOrdinal];
AnalysisValue <span style=color:#f92672>:=</span> CalcAmt<span style=color:#f92672>(</span>ValueType,TRUE<span style=color:#f92672>)</span>;
MATRIX_CellData[MATRIX_ColumnOrdinal] <span style=color:#f92672>:=</span> AnalysisValue;
<span style=color:#66d9ef>END</span>;
</code></pre></div><p>Good code</p>
<div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-al data-lang=al><span style=color:#66d9ef>PROCEDURE</span> MATRIX_OnAfterGetRecord@<span style=color:#ae81ff>10</span><span style=color:#f92672>(</span>MATRIX_ColumnOrdinal : <span style=color:#66d9ef>Integer</span><span style=color:#f92672>)</span>;
<span style=color:#66d9ef>BEGIN</span>
MatrixRecord <span style=color:#f92672>:=</span> MatrixRecords[MATRIX_ColumnOrdinal];
AnalysisValue <span style=color:#f92672>:=</span> CalcAmt<span style=color:#f92672>(</span>ValueType,TRUE<span style=color:#f92672>)</span>;
MATRIX_CellData[MATRIX_ColumnOrdinal] <span style=color:#f92672>:=</span> AnalysisValue;
<span style=color:#66d9ef>END</span>;
</code></pre></div>
<footer class=footline>
</footer>
</main>
@ -295,12 +293,12 @@ END;
<div style=left:-1000px;overflow:scroll;position:absolute;top:-1000px;border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px>
<div style=border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px></div>
</div>
<script src=/js/clipboard.min.js?1644506470></script>
<script src=/js/perfect-scrollbar.min.js?1644506470></script>
<script src=/js/perfect-scrollbar.jquery.min.js?1644506470></script>
<script src=/js/jquery.svg.pan.zoom.js?1644506470></script>
<script src=/js/featherlight.min.js?1644506470></script>
<script src=/js/modernizr.custom-3.6.0.js?1644506470></script>
<script src=/js/relearn.js?1644506470></script>
<script src=/js/clipboard.min.js?1644600600></script>
<script src=/js/perfect-scrollbar.min.js?1644600600></script>
<script src=/js/perfect-scrollbar.jquery.min.js?1644600600></script>
<script src=/js/jquery.svg.pan.zoom.js?1644600600></script>
<script src=/js/featherlight.min.js?1644600600></script>
<script src=/js/modernizr.custom-3.6.0.js?1644600600></script>
<script src=/js/relearn.js?1644600600></script>
</body>
</html>