{"id":17,"date":"2016-01-15T22:48:34","date_gmt":"2016-01-15T22:48:34","guid":{"rendered":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/?p=17"},"modified":"2016-02-29T01:52:52","modified_gmt":"2016-02-29T01:52:52","slug":"week-1","status":"publish","type":"post","link":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/2016\/01\/15\/week-1\/","title":{"rendered":"Week 1"},"content":{"rendered":"<h4>This week was the first of our semester long project.<\/h4>\n<p><strong>[General]<\/strong><\/p>\n<p>Set up weekly adviser meeting with Dave Culyba and Shirley Saldamarco every Monday from 1:30 pm to 2:30.<\/p>\n<p>For the core hour, we set up weekly core hours where all members of team will be together to do work on project.<\/p>\n<p>From 2: 00 pm \u00a0to 9:00 pm every Monday, Wednesday and Friday.<\/p>\n<p>From 4:00 pm to 9:00 pm every Tuesday and Thursday.<\/p>\n<p>Officially we will work 35 hrs a week at least. However we probably work during weekend too.<\/p>\n<p><strong>[Development]<\/strong><\/p>\n<p>Our team have 4 programmers such as Server programmer, Unity programmer, Android programmer and voice recognition programmer. So it will be difficult to integrate all different projects.<\/p>\n<p>Our lead programmer Yang made documentation for programming naming fashion to easy to integration.<\/p>\n<h6><strong>C#<\/strong><br \/>\n&#8211; <span style=\"color: #ff0000;\">Class<\/span>:<br \/>\n&#8212; Follow upper camel case convention.<br \/>\n&#8212; The name of a class should be noun.<br \/>\n&#8212; Example: class GameManager.<\/h6>\n<h6>&#8211; <span style=\"color: #ff0000;\">Variable \/ Property<span style=\"color: #000000;\">:<\/span><\/span><br \/>\n&#8212; Follow lower camel case convention.<br \/>\n&#8212; For private variables add an underscore before name.<br \/>\n&#8212; Avoid meaningless or ambiguous (&#8220;i&#8221;, &#8220;j&#8221;, &#8220;count&#8221;, etc) unless variables are used as loop indices.<br \/>\n&#8212; Example: public int maxHealth \/ private int _currHealth<\/h6>\n<h6>&#8211; <span style=\"color: #ff0000;\">Function<\/span>:<br \/>\n&#8212; Follow upper camel case convention.<br \/>\n&#8212; The name of a function should be verb.<br \/>\n&#8212; The names of function parameters follow the same rule as variables.<br \/>\n&#8212; Example: void InitGame(int level).<\/h6>\n<h6>&#8211; <span style=\"color: #ff0000;\">Interface<\/span>:<br \/>\n&#8212; Follow upper camel case convention with prefix &#8220;I&#8221; (abbr. for &#8220;Interface&#8221;)<br \/>\n&#8212; The name should well abstract the usage of interface<br \/>\n&#8212; Example: interface FsmState.<\/h6>\n<h6>&#8211; <span style=\"color: #ff0000;\">Namespace<\/span>:<br \/>\n&#8212; Follow upper camel case convention<br \/>\n&#8212; The name of a namespace should well summarized the feature of the whole module, and should be a noun.<br \/>\n&#8212; Example: namespace PhysicModule.<\/h6>\n<h6>&#8211; <span style=\"color: #ff0000;\">Macro, Constant, &amp; Preprocessor<\/span>:<br \/>\n&#8212; Follow capitalized with underscores convention.<br \/>\n&#8212; Example: UNITY_EDITOR.<\/h6>\n<h6>&#8211; <span style=\"color: #ff0000;\">Delegate &amp; Event<\/span>:<br \/>\n&#8212; Name delegate type by following upper camel case convention with postfix &#8220;_Handler&#8221;.<br \/>\n&#8212; Name event by following upper camel case convention with prefix &#8220;On&#8221;.<br \/>\n&#8212; Example: delegate void MonsterDeath_Handler \/ void OnMonsterDeath()<\/h6>\n<h6>&#8211; <span style=\"color: #ff0000;\">Coroutine: upper camel case with postfix &#8220;_CR&#8221; (abbr. for &#8220;Coroutine&#8221;)<\/span><br \/>\n&#8212; Follow upper camel case convention with postfix &#8220;_CR&#8221;<br \/>\n&#8212; Example: IEnumerator MonsterMove_CR().<\/h6>\n<h6><span style=\"color: #ff0000;\">II. Programming comment fashion<\/span><br \/>\n&#8211; File description<br \/>\n&#8212; Author and last modified date.<br \/>\n&#8212; What is this file for?<br \/>\n&#8212; Dependencies (Is there other files that it has to work together with ?).<br \/>\n&#8212; If necessary, include a short example to indicate expected usage.<br \/>\n&#8212; Highlight potential bugs and known issues, if any.<\/h6>\n<h6>&#8211; <span style=\"color: #ff0000;\">Class \/ Interface description<\/span><br \/>\n&#8212; What is this class for?<\/h6>\n<h6>&#8211; <span style=\"color: #ff0000;\">Variable \/ Property<\/span><br \/>\n&#8212; Write short description for all public ones, and protected ones if the class is intended to be inherited.<br \/>\n&#8212; Highlight those that you don&#8217;t want clients to touch.<\/h6>\n<h6>&#8211; <span style=\"color: #ff0000;\">Function<\/span><br \/>\n&#8212; Write short description for all public ones, and protected ones if the class is intended to be inherited.<br \/>\n&#8212; Specify input and output.<br \/>\n&#8212; Highlight those that you don&#8217;t want clients to touch.<\/h6>\n<h6><span style=\"color: #ff0000;\">III. Unity Project Arrangement<\/span><br \/>\n&#8211; Folder hierarchy: organized based on modules rather than the type of files (except Editor and Plugin folders).<br \/>\n&#8211; Example:<br \/>\n&#8211; Assets<br \/>\n|- Monster<br \/>\n|- Hero<br \/>\n|- Map<\/h6>\n<h6>&#8211; Resource folder: created under module folder to include resources need to be loaded during run time<br \/>\n&#8211; Asset naming fashion: follow upper camel case rules with lower cased prefix that indicates asset type.<br \/>\nModel: fbx_<br \/>\nTexture: tex_<br \/>\nShader: sh_<br \/>\nMaterial: mat_<br \/>\nPrefab: pb_<br \/>\nAnimator: anim_<br \/>\nScene: sc_<\/h6>\n<h6><span style=\"color: #ff0000;\">IV. Perforce usage<\/span><br \/>\n&#8211; Only upload \/Assets and \/ProjectSettings<br \/>\n&#8211; Write commit description every time including the following information:<br \/>\n&#8212; which file is added<br \/>\n&#8212; which file is deleted<br \/>\n&#8212; which file is moved from where to where<br \/>\n&#8212; which file is updated, what part is modified<\/h6>\n<p>Now we are ready to start!<\/p>\n<p>&nbsp;<\/p>\n<p>&nbsp;<\/p>\n<h4><strong>\u00a0<\/strong><\/h4>\n","protected":false},"excerpt":{"rendered":"<p>This week was the first of our semester long project. [General] Set up weekly adviser meeting with Dave Culyba and Shirley Saldamarco every Monday from 1:30 pm to 2:30. For the core hour, we set up weekly core hours where all members of team will be together to do work on project. From 2: 00 <a href=\"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/2016\/01\/15\/week-1\/\" rel=\"nofollow\"><span class=\"sr-only\">Read more about Week 1<\/span>[&hellip;]<\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"pgc_meta":"","footnotes":""},"categories":[1],"tags":[],"class_list":["post-17","post","type-post","status-publish","format-standard","hentry","category-vr-rehearsal"],"_links":{"self":[{"href":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/wp-json\/wp\/v2\/posts\/17"}],"collection":[{"href":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/wp-json\/wp\/v2\/comments?post=17"}],"version-history":[{"count":26,"href":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/wp-json\/wp\/v2\/posts\/17\/revisions"}],"predecessor-version":[{"id":109,"href":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/wp-json\/wp\/v2\/posts\/17\/revisions\/109"}],"wp:attachment":[{"href":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/wp-json\/wp\/v2\/media?parent=17"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/wp-json\/wp\/v2\/categories?post=17"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/projects-old.etc.cmu.edu\/vr-rehearsal\/index.php\/wp-json\/wp\/v2\/tags?post=17"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}