{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"This page is a guide on how to start a new project. This section will cover several concepts and basic programming knowledge. I invite you to reproduce the examples on your own even if they are simple and modify them to learn by observing the behavior of your program.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Creation of a project","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"What is the #include?","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The namespaces","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The standard library","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"What is a function?","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The use of comments","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Consultez la version francophone de cette page.","type":"text","marks":[{"type":"em"},{"type":"link","attrs":{"href":"https://robocrc.atlassian.net/wiki/spaces/PT/pages/710869223"}}]}]},{"type":"paragraph","content":[{"text":"Don’t hesitate to provide us with your feedback, comments and suggestions on our content. Contact us at ","type":"text"},{"text":"info.crc@sciencetech.ca","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:info.crc@sciencetech.ca"}}]},{"text":".","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"My first project","type":"text"}]},{"type":"paragraph","content":[{"text":"I invite you to listen to the following capsule to learn how to create your first project and write your first program!","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"iframe","parameters":{"macroParams":{"src":{"value":"https://www.youtube.com/embed/fAcUKSvjhOA"},"width":{"value":"760px"},"frameborder":{"value":"hide"},"align":{"value":"middle"},"height":{"value":"428px"}},"macroMetadata":{"macroId":{"value":"f8c82e0e-1d91-476c-86cc-387a52800a18"},"schemaVersion":{"value":"1"},"title":"Iframe"}}}},{"type":"heading","attrs":{"level":1},"content":[{"text":"What is the #include?","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"#include","type":"text","marks":[{"type":"em"}]},{"text":" allows you to add source files to your own file. And now, some of you will say, \"Yes, but still....\". The goal is actually to split your code and make it easier to maintain and reuse. When you put a #include at the beginning of your file, when it’s time to compile, the compiler will add the included file to your file.","type":"text"}]},{"type":"paragraph","content":[{"text":"In the code that follows, I modified the previously made project to split it into 2 files and show you a simple example of how a #include works. We can see that, in the following example, the ","type":"text"},{"text":"main()","type":"text","marks":[{"type":"em"}]},{"text":" function of the ","type":"text"},{"text":"HelloWorld","type":"text","marks":[{"type":"em"}]},{"text":" file calls the ","type":"text"},{"text":"helloWorld()","type":"text","marks":[{"type":"em"}]},{"text":" function of the ","type":"text"},{"text":"Message ","type":"text","marks":[{"type":"em"}]},{"text":"file. The ","type":"text"},{"text":"Message ","type":"text","marks":[{"type":"em"}]},{"text":"file is included at the beginning of the ","type":"text"},{"text":"HelloWorld ","type":"text","marks":[{"type":"em"}]},{"text":"file and will therefore be added under this line when it’s time to compile.","type":"text"}]},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"HelloWorld.cpp","type":"text"}]},{"type":"codeBlock","attrs":{"language":"c++"},"content":[{"text":"#include \"Message.cpp\"\n\nint main(){\n\n helloWorld();\n \n return 0;\n}","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"Message.cpp","type":"text"}]},{"type":"codeBlock","attrs":{"language":"c++"},"content":[{"text":"#include \n\nusing namespace std;\n\nvoid helloWorld(){\n\n cout << \"Hello world!\";\n}","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"File upon compilation","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Note ","type":"text","marks":[{"type":"strong"}]},{"text":"that I didn't insert the code of the ","type":"text"},{"text":"#include ","type":"text","marks":[{"type":"em"}]},{"text":", because this library is simply too big and would ruin the example.","type":"text"}]}]},{"type":"codeBlock","content":[{"text":"#include \n\nusing namespace std;\n\nvoid helloWorld(){\n\n cout << \"Hello world!\";\n}\n\nint main(){\n\n helloWorld();\n \n return 0;\n}","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"The namespaces","type":"text"}]},{"type":"paragraph","content":[{"text":"Namespaces ","type":"text","marks":[{"type":"em"}]},{"text":"are used to allow the user to have variable names, function names and much more with identical names. When you write ","type":"text"},{"text":"using namespace std","type":"text","marks":[{"type":"em"}]},{"text":", you remove the need to specify from which namespace the variable or function you are using comes.","type":"text"}]},{"type":"paragraph","content":[{"text":"In the following example, we will create 2 ","type":"text"},{"text":"namespaces ","type":"text","marks":[{"type":"em"}]},{"text":"that we will use in our ","type":"text"},{"text":"main","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]},{"type":"layoutSection","marks":[{"type":"breakout","attrs":{"mode":"wide"}}],"content":[{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"main.cpp","type":"text"}]},{"type":"codeBlock","content":[{"text":"#include \"namespaceA.cpp\"\n#include \"namespaceB.cpp\"\n\nusing namespace A;\n\nint main (){\n\n helloWorld();\n B::helloWorld();\n \n return 0;\n}","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"namespaceA.cpp","type":"text"}]},{"type":"codeBlock","attrs":{"language":"c++"},"content":[{"text":"#include \n\nnamespace A\n{\n void helloWorld()\n {\n std::cout << \"Hello world!\";\n }\n}","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"namespaceB.cpp","type":"text"}]},{"type":"codeBlock","attrs":{"language":"c++"},"content":[{"text":"#include \n\nnamespace B\n{\n void helloWorld()\n {\n std::cout << \"Hello World!!!\";\n }\n}","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Console output:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"Hello world!Hello World!!!","type":"text"}]},{"type":"paragraph","content":[{"text":"You can see in the previous example that we declare ","type":"text"},{"text":"namespace ","type":"text","marks":[{"type":"em"}]},{"text":"A as the ","type":"text"},{"text":"namespace ","type":"text","marks":[{"type":"em"}]},{"text":"used in ","type":"text"},{"text":"main.cpp","type":"text","marks":[{"type":"em"}]},{"text":". Then, when we call the ","type":"text"},{"text":"helloWorld()","type":"text","marks":[{"type":"em"}]},{"text":" function, the program takes the function in ","type":"text"},{"text":"namespace ","type":"text","marks":[{"type":"em"}]},{"text":"A. When we call the ","type":"text"},{"text":"helloWorld() ","type":"text","marks":[{"type":"em"}]},{"text":"function in ","type":"text"},{"text":"namespace ","type":"text","marks":[{"type":"em"}]},{"text":"B, we need to add ","type":"text"},{"text":"B::","type":"text","marks":[{"type":"em"}]},{"text":" to tell the program which ","type":"text"},{"text":"namespace ","type":"text","marks":[{"type":"em"}]},{"text":"to use. The same behavior can be observed for the standard library when using the ","type":"text"},{"text":"cout ","type":"text","marks":[{"type":"em"}]},{"text":"function.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"The Standard Library","type":"text"}]},{"type":"paragraph","content":[{"text":"C/C++ uses the standard library hence the name ","type":"text"},{"text":"std","type":"text","marks":[{"type":"em"}]},{"text":". The standard library is a collection of general and very useful functions. In fact, when you include ","type":"text"},{"text":"iostream","type":"text","marks":[{"type":"em"}]},{"text":", you include part of the standard library! If you want to discover the multiple functions of the standard library, I invite you to ","type":"text"},{"text":"click here","type":"text","marks":[{"type":"link","attrs":{"href":"https://en.cppreference.com/w/cpp/header"}}]},{"text":" and have a look.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"What is a function?","type":"text"}]},{"type":"paragraph","content":[{"text":"The function is a kind of “subprogram”, a \"subroutine\". It is mainly used to avoid code repetition and to make a program easier to read and maintain. Several tips can help when creating a function.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Make a function that performs a single task","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Give it a representative and clear name","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Minimize the number of arguments","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Here is an example of a function call that multiplies 2 integers (int) and returns the value of an integer product (int).","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"wrap-right","width":65.0},"content":[{"type":"media","attrs":{"width":413,"id":"8bc23e49-dccb-4f03-9c84-22335f4c2155","collection":"contentId-710869223","type":"file","height":105}}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Return value type","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name of the function","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"First argument type","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name of the first argument","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Second argument type","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name of the second argument","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"The Use of Comments","type":"text"}]},{"type":"paragraph","content":[{"text":"Although comments are a good way to document our code, we must avoid abusing them. It should never be necessary to comment on the code line by line. Often, this practice is due to a lack of clarity in variable and/or function names. Sometimes, functions that are too long and that do several actions at once can be the cause of this problem.","type":"text"}]},{"type":"paragraph","content":[{"text":"Here are some cases where the use of comments is relevant:","type":"text"}]},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"In order to provide information on copyright, the usefulness of the file, its version and others.","type":"text"}]},{"type":"paragraph","content":[{"text":"This information is always found in the header of the file.","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":374,"id":"ba45595d-0533-42d5-9cc8-bacc41779aa4","collection":"contentId-710869223","type":"file","height":247}}]}]}]},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"The information on a function - either a small explanation of the purpose of the function, the variables in parameters as well as the return variable.","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":466,"id":"13235556-47d8-40bf-8c61-e6e33ef2177b","collection":"contentId-710869223","type":"file","height":207}}]}]}]},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"paragraph","content":[{"text":"Leave a note temporarily and remove it once the correction is made.","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":50.0},"content":[{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":494,"id":"8d8a5116-6907-45e6-9b4d-61981acabca6","collection":"contentId-710869223","type":"file","height":139}}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Related Articles","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"contentbylabel","parameters":{"macroParams":{"sort":{"value":"title"},"excerptType":{"value":"rich content"},"cql":{"value":"label = \"ar-guide_demarrage\""}},"macroMetadata":{"macroId":{"value":"71856f4f-c457-474a-9e8a-21560af565fd"},"schemaVersion":{"value":"4"},"title":"Content by Label"}}}}],"version":1}