{"id":1650,"date":"2012-04-13T11:59:03","date_gmt":"2012-04-13T09:59:03","guid":{"rendered":"http:\/\/www.auditsi.eu\/?p=1650"},"modified":"2013-11-02T15:35:38","modified_gmt":"2013-11-02T13:35:38","slug":"initiation-a-la-programmation-en-basic-etape-4-documentation-et-presentation-du-code-source","status":"publish","type":"post","link":"https:\/\/www.auditsi.eu\/?p=1650","title":{"rendered":"Initiation \u00e0 la programmation en Basic &#8211; ETAPE 4 : Documentation et pr\u00e9sentation du code-source"},"content":{"rendered":"<p style=\"text-align: justify;\">Le code-source* est une succession de lignes de codes qui atteint vite quelques milliers de lignes (par exemple, le projet de d\u00e9veloppement qui m\u2019occupe actuellement (un g\u00e9n\u00e9rateur de synth\u00e8ses g\u00e9n\u00e9rales pour le CAC, cf <a href=\"http:\/\/www.auditsi.eu\/?p=1533\">http:\/\/www.auditsi.eu\/?p=1533<\/a>) d\u00e9passe d\u00e9j\u00e0 les six mille lignes) ; autant dire que la documentation et la pr\u00e9sentation du code-source sont primordiales pour s\u2019y retrouver\u2026 aussi primordiales que pour un dossier de CAC !<\/p>\n<p style=\"text-align: justify;\">La lisibilit\u00e9 du code-source est am\u00e9lior\u00e9e par :<\/p>\n<ul>\n<li>\n<div style=\"text-align: justify;\">l\u2019ajout de <em><strong>commentaires<\/strong><\/em> expliquant le fonctionnement du programme. Les commentaires sont incontournables ; c\u2019est l\u2019aide-m\u00e9moire du programmeur ; ces commentaires lui permettront de comprendre \u00e0 quoi sert telle ligne de code\u2026 quand quelques mois plus tard, il aura \u00e0 compl\u00e9ter son programme&#8230; Les commentaires sont pr\u00e9c\u00e9d\u00e9s d\u2019une apostrophe (touche \u00ab 4 \u00bb du clavier alphanum\u00e9rique) ou par le mot clef REM (pour REMARK) ; ils ne sont ni compil\u00e9s ni ex\u00e9cut\u00e9s (ces termes sont expliqu\u00e9s dans une prochaine \u00e9tape). L\u2019utilisateur du programme n\u2019a pas acc\u00e8s \u00e0 ces informations. Les commentaires ne sont visibles que de l\u2019auteur du code-source (ou de son \u00e9quipe en cas de projets de grande envergure ; dans ce cas, les commentaires sont un moyen de communication interne\u2026). Dans l\u2019exemple qui suit, les commentaires fournissent des informations sur l\u2019auteur du programme et annoncent les diff\u00e9rentes parties du code-source (par exemple, la d\u00e9claration des variables).<\/div>\n<\/li>\n<\/ul>\n<div><a href=\"https:\/\/www.auditsi.eu\/wp-content\/uploads\/2012\/04\/freeBasic-colorisation.jpg\"><img loading=\"lazy\" decoding=\"async\" class=\"size-full wp-image-1651 aligncenter\" title=\"freeBasic colorisation\" src=\"https:\/\/www.auditsi.eu\/wp-content\/uploads\/2012\/04\/freeBasic-colorisation.jpg\" alt=\"\" width=\"500\" height=\"299\" srcset=\"https:\/\/www.auditsi.eu\/wp-content\/uploads\/2012\/04\/freeBasic-colorisation.jpg 500w, https:\/\/www.auditsi.eu\/wp-content\/uploads\/2012\/04\/freeBasic-colorisation-300x179.jpg 300w, https:\/\/www.auditsi.eu\/wp-content\/uploads\/2012\/04\/freeBasic-colorisation-1x1.jpg 1w\" sizes=\"auto, (max-width: 500px) 100vw, 500px\" \/><\/a><\/div>\n<div style=\"text-align: justify;\"><\/div>\n<ul>\n<li>\n<div style=\"text-align: justify;\">l\u2019<strong><em>indentation<\/em><\/strong> (c\u2019est-\u00e0-dire le retrait le texte du code-source par rapport \u00e0 la marge gauche) ; celle-ci permet de suivre visuellement la progression du programme dans les boucles et proc\u00e9dures (ces notions seront abord\u00e9es ult\u00e9rieurement). Cette mise en forme est purement conventionnelle ; le fait de ne pas la respecter n\u2019a aucune incidence sur l\u2019ex\u00e9cution du code mais r\u00e9duit sensiblement sa compr\u00e9hension par un autre programmeur.<\/div>\n<\/li>\n<\/ul>\n<div style=\"text-align: justify;\"><a href=\"https:\/\/www.auditsi.eu\/wp-content\/uploads\/2012\/04\/freeBasic-indentation-colorisation.jpg\"><img loading=\"lazy\" decoding=\"async\" class=\" wp-image-1652 aligncenter\" title=\"freeBasic indentation colorisation\" src=\"https:\/\/www.auditsi.eu\/wp-content\/uploads\/2012\/04\/freeBasic-indentation-colorisation.jpg\" alt=\"\" width=\"593\" height=\"85\" \/><\/a><\/div>\n<ul>\n<li>\n<div style=\"text-align: justify;\">la <strong><em>colorisation<\/em><\/strong> du code-source. Chaque composant du code-source (mot clef, variable, op\u00e9rateur\u2026) est color\u00e9 diff\u00e9remment facilitant sa lecture et la d\u00e9tection des erreurs de saisie. L\u2019EDI colorise automatiquement le code-source, nul besoin donc\u00a0de sortir ses feutres et autres crayons de couleur**\u2026<\/div>\n<\/li>\n<\/ul>\n<p style=\"text-align: justify;\">Cet article est le dernier d\u2019une s\u00e9rie que les plus impatients trouveront plut\u00f4t th\u00e9orique. Le prochain article nous permettra de rentrer dans le vif du sujet, de franchir un nouvel horizon, celui de l\u2019homme qui dompte la machine (toujours avec une simplicit\u00e9 confondante) ! Vous commencerez \u00e0 interagir avec la machine et surtout \u00e0 la faire travailler\u2026 \u00e0 votre place !<\/p>\n<p style=\"text-align: justify;\">_____<\/p>\n<p style=\"text-align: justify;\"><span style=\"font-size: x-small;\">* Le code-source correspond au texte du programme tel qu\u2019il appara\u00eet dans la zone d\u2019\u00e9dition de l\u2019EDI.<\/span><\/p>\n<p style=\"text-align: justify;\"><span style=\"font-size: x-small;\">** Petit clin d\u2019oeil \u00e0 certaines de mes coll\u00e8gues sans lesquelles nos dossiers seraient bien tristes\u2026<\/span><\/p>\n<div style=\"padding-bottom:20px; padding-top:10px;\" class=\"hupso-share-buttons\"><!-- Hupso Share Buttons - https:\/\/www.hupso.com\/share\/ --><a class=\"hupso_counters\" href=\"https:\/\/www.hupso.com\/share\/\"><img decoding=\"async\" src=\"https:\/\/static.hupso.com\/share\/buttons\/lang\/fr\/share-small.png\" style=\"border:0px; padding-top:2px; float:left;\" alt=\"Share Button\"\/><\/a><script type=\"text\/javascript\">var hupso_services_c=new Array(\"twitter\",\"facebook_like\",\"facebook_send\",\"email\",\"print\",\"linkedin\");var hupso_counters_lang = \"fr_FR\";var hupso_image_folder_url = \"\";var hupso_twitter_via=\"BenoitRiviere14\";var hupso_url_c=\"\";var hupso_title_c=\"Initiation%20%C3%A0%20la%20programmation%20en%20Basic%20-%20ETAPE%204%20%3A%20Documentation%20et%20pr%C3%A9sentation%20du%20code-source\";<\/script><script type=\"text\/javascript\" src=\"https:\/\/static.hupso.com\/share\/js\/counters.js\"><\/script><!-- Hupso Share Buttons --><\/div>","protected":false},"excerpt":{"rendered":"<p>Le code-source* est une succession de lignes de codes qui atteint vite quelques milliers de lignes (par exemple, le projet de d\u00e9veloppement qui m\u2019occupe actuellement (un g\u00e9n\u00e9rateur de synth\u00e8ses g\u00e9n\u00e9rales pour le CAC, cf http:\/\/www.auditsi.eu\/?p=1533) d\u00e9passe d\u00e9j\u00e0 les six mille lignes) ; autant dire que la documentation et la pr\u00e9sentation du code-source sont primordiales pour &#8230;<\/p>\n<p><a href=\"https:\/\/www.auditsi.eu\/?p=1650\" class=\"more-link\">Continue reading &lsquo;Initiation \u00e0 la programmation en Basic &#8211; ETAPE 4 : Documentation et pr\u00e9sentation du code-source&rsquo; &raquo;<\/a><\/p>\n<div style=\"padding-bottom:20px; padding-top:10px;\" class=\"hupso-share-buttons\"><!-- Hupso Share Buttons - https:\/\/www.hupso.com\/share\/ --><a class=\"hupso_counters\" href=\"https:\/\/www.hupso.com\/share\/\"><img src=\"https:\/\/static.hupso.com\/share\/buttons\/lang\/fr\/share-small.png\" style=\"border:0px; padding-top:2px; float:left;\" alt=\"Share Button\"\/><\/a><script type=\"text\/javascript\">var hupso_services_c=new Array(\"twitter\",\"facebook_like\",\"facebook_send\",\"email\",\"print\",\"linkedin\");var hupso_counters_lang = \"fr_FR\";var hupso_image_folder_url = \"\";var hupso_twitter_via=\"BenoitRiviere14\";var hupso_url_c=\"\";var hupso_title_c=\"Initiation%20%C3%A0%20la%20programmation%20en%20Basic%20-%20ETAPE%204%20%3A%20Documentation%20et%20pr%C3%A9sentation%20du%20code-source\";<\/script><script type=\"text\/javascript\" src=\"https:\/\/static.hupso.com\/share\/js\/counters.js\"><\/script><!-- Hupso Share Buttons --><\/div>","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"advanced_seo_description":"","jetpack_seo_html_title":"","jetpack_seo_noindex":false,"ngg_post_thumbnail":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","_links_to":"","_links_to_target":""},"categories":[442,39,1207,215],"tags":[1209,1647,98,854,851,855,254,274,852,663,1641],"class_list":["post-1650","post","type-post","status-publish","format-standard","hentry","category-basic","category-cas-pratiques","category-initiation-au-basic","category-vba","tag-1209","tag-basic","tag-code-source","tag-colorisation","tag-commentaires","tag-documentation","tag-edi","tag-programmation","tag-rem","tag-tutoriel","tag-vba"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_likes_enabled":false,"_links":{"self":[{"href":"https:\/\/www.auditsi.eu\/index.php?rest_route=\/wp\/v2\/posts\/1650","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.auditsi.eu\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.auditsi.eu\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.auditsi.eu\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.auditsi.eu\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1650"}],"version-history":[{"count":7,"href":"https:\/\/www.auditsi.eu\/index.php?rest_route=\/wp\/v2\/posts\/1650\/revisions"}],"predecessor-version":[{"id":1657,"href":"https:\/\/www.auditsi.eu\/index.php?rest_route=\/wp\/v2\/posts\/1650\/revisions\/1657"}],"wp:attachment":[{"href":"https:\/\/www.auditsi.eu\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1650"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.auditsi.eu\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1650"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.auditsi.eu\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1650"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}