backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-21 12:23:13 +08:00
Code Issues Projects Releases Wiki Activity

Documentation for 4ed75018e3

Browse Source
This commit is contained in:
github-actions
2020-08-28 16:49:56 +00:00
parent 4cb900f32b
commit 9a033391c9
1 changed files with 15 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html
View File

@@ -160,7 +160,7 @@ Typical structure of a program:</h3>
<div class="line"> </div>
<div class="line"><span class="preprocessor">#include </span></div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment">/** </span></div>
<div class="line"><span class="comment">/**</span></div>
<div class="line"><span class="comment"> * @namespace &lt;check from other files in this repo&gt;</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"><span class="keyword">namespace </span>name {</div>
@@ -168,42 +168,44 @@ Typical structure of a program:</h3>
<div class="line"><span class="comment">/**</span></div>
<div class="line"><span class="comment"> * Class documentation</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"><span class="keyword">class </span>cls_name{</div>
<div class="line"><span class="keyword">class </span>class_name {</div>
<div class="line"> <span class="keyword">private</span>:</div>
<div class="line"> <span class="keywordtype">int</span> var1; <span class="comment">///&lt; short info of this variable</span></div>
<div class="line"><span class="comment"></span> <span class="keywordtype">char</span> *msg; <span class="comment">///&lt; short info</span></div>
<div class="line"> <span class="keywordtype">int</span> variable; <span class="comment">///&lt; short info of this variable</span></div>
<div class="line"><span class="comment"></span> <span class="keywordtype">char</span> *message; <span class="comment">///&lt; short info</span></div>
<div class="line"><span class="comment"></span> </div>
<div class="line"> <span class="keyword">public</span>:</div>
<div class="line"> <span class="comment">// other members also documented as below</span></div>
<div class="line"> <span class="comment">// other members also documented as below</span></div>
<div class="line">}</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment">/**</span></div>
<div class="line"><span class="comment"> * Function documentation </span></div>
<div class="line"><span class="comment"> * Function documentation</span></div>
<div class="line"><span class="comment"> * @tparam T this is a one-line info about T</span></div>
<div class="line"><span class="comment"> * @param param1 on-line info about param1</span></div>
<div class="line"><span class="comment"> * @param param2 on-line info about param2</span></div>
<div class="line"><span class="comment"> * @returns `true` if ...</span></div>
<div class="line"><span class="comment"> * @returns `false` if ... </span></div>
<div class="line"><span class="comment"> * @returns `false` if ...</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"><span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt;</div>
<div class="line"><span class="keywordtype">bool</span> func(<span class="keywordtype">int</span> param1, T param2) {</div>
<div class="line"> <span class="comment">// function statements here </span></div>
<div class="line"> <span class="keywordflow">if</span>(<span class="comment">/*something bad*/</span>)</div>
<div class="line"> <span class="comment">// function statements here</span></div>
<div class="line"> <span class="keywordflow">if</span> (<span class="comment">/*something bad*/</span>) {</div>
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line">}</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment">/** Test function */</span></div>
<div class="line"><span class="keywordtype">void</span> <a class="code" href="../../d6/d2c/caesar__cipher_8cpp.html#ae1a3968e7947464bee7714f6d43b7002">test</a>() {</div>
<div class="line"> <span class="comment">/* some statements */</span></div>
<div class="line"> assert(func(...) == ...); <span class="comment">// this ensures that the algorithm works as expected </span></div>
<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="../../d6/d2c/caesar__cipher_8cpp.html#ae1a3968e7947464bee7714f6d43b7002">test</a>() {</div>
<div class="line"> <span class="comment">/* desciptions of the following test */</span></div>
<div class="line"> assert(func(...) == ...); <span class="comment">// this ensures that the algorithm works as expected</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">// can have multiple checks</span></div>
<div class="line"> <span class="comment">// can have multiple checks</span></div>
<div class="line">}</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment">/** Main function */</span></div>
<div class="line"><span class="keywordtype">int</span> <a class="code" href="../../d3/d40/graph__coloring_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[]) {</div>
<div class="line"> <a class="code" href="../../d6/d2c/caesar__cipher_8cpp.html#ae1a3968e7947464bee7714f6d43b7002">test</a>(); <span class="comment">// execute the tests</span></div>
<div class="line"> <span class="comment">// code here</span></div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>