Skip to content
Snippets Groups Projects
Commit ce41b754 authored by Ori Almog's avatar Ori Almog
Browse files

Coding style

parent 54602a72
No related branches found
No related tags found
No related merge requests found
\BOOKMARK [1][-]{section.1}{Team Meeting Plan}{}% 1
\BOOKMARK [1][-]{section.2}{Team Communication Plan}{}% 2
\BOOKMARK [1][-]{section.3}{Team Member Roles}{}% 3
\BOOKMARK [1][-]{section.4}{Git Workflow Plan}{}% 4
\BOOKMARK [1][-]{section.5}{Proof of Concept Demonstration Plan}{}% 5
\BOOKMARK [1][-]{section.6}{Technology}{}% 6
\BOOKMARK [1][-]{section.7}{Coding Style}{}% 7
\BOOKMARK [1][-]{section.8}{Project Schedule}{}% 8
\BOOKMARK [1][-]{section.9}{Project Review}{}% 9
No preview for this file type
......@@ -3,6 +3,7 @@
\usepackage{booktabs}
\usepackage{tabularx}
\usepackage{indentfirst}
\usepackage{hyperref}
\title{SE 3XA3: Development Plan\\Rogue Reborn}
......@@ -84,10 +85,19 @@ With respect to the environment of the technology, the Rogue++ team agreed to us
\section{Coding Style}
In any large-scale project, it is important that all members are on the same page. This is especially true for a software project, where every team member must be able to read and understand the code that another wrote. The Rogue++ project will be utilizing a modified version of \href{https://google.github.io/styleguide/cppguide.html}{Google's C++ Style Guide} to format and organize the code. Google's style guides are a professional standard, utilized in every corner of the software industry. The team has decided to implement some changes to it, however, primarily due to the nature of the project and past proramming experience. As with any style guide, what is most important is that the code is persistent, not that it conforms to one system or another. Having said that, the team shall differ on two matters from Google's style guide:
\begin{itemize}
\item Opening and closing curly braces (\{\}) shall be on the same column. The reason for this is simple: curly braces are used to separate code blocks and to designate to whom or what a piece of code belongs. In a trivial case it makes no difference, but with multiple layers of nested for-loops, if-statements, and function definitions, opening and closing curly braces on new lines will yield code that is easier to read and easier to debug.
\item Google's C++ Style Guide calls for inline comments describing classes, functions, methods, and file contents. While this is a noble goal, and is most definietly necessary, this job has been delegated elsewhere. As mentioned before, the team will be using the Doxygen tool for documenting code structure. Doxygen will encapsulate the design-documentation sphere, stepping into a fair portion of Google's style guide. The team will still, of course, leave in-line comments explaining the functional aspects of the code.
\end{itemize}
\section{Project Schedule}
Provide a pointer to your Gantt Chart.
\section{Project Review}
\end{document}D
\ No newline at end of file
\end{document}
\ No newline at end of file
Require Docs Sep 26 Oct 7
Milestone 1 (Rev -1) Oct 10 Oct 14 (Break)
Explore Tech Oct 17 Oct 21
BOOST + Test Plan Oct 24 Oct 28
Design Doc Oct 31 Nov 11
Rev 0 (Milestone 2) Oct 21 Nov 19
Rev 1 fixes (Milestone 3) Nov 18 Nov 30
Design Doc Final Nov 26 Dec 7
Dues 0 → 100644
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment