Add more rules based on my thinking. #1

reyoung · 2016-12-15T03:14:03Z

No description provided.

breakds

I am not an expert on ABIs and may need another pair of eyes to review rules on that. Or rather can you give a write-up on ABIs? That would be awesome :)

breakds · 2016-12-17T17:37:17Z

README.md

+    *   ** Do not** Use them in `.cpp`/`.h` files. Using `static` for hidding
+        symbols in source files. The anonymous namespace will generate a namespace
+        when compiling, and could generate a different namespace name each time.
+        It will breaks the ABIs, make dubug harder.


s/dubug/debug/
s/breaks/break

breakds · 2016-12-17T17:38:04Z

README.md

-    *   Sometimes you may want to expose internal functions or
+    *   ** Do not** Use them in `.cpp`/`.h` files. Using `static` for hidding
+        symbols in source files. The anonymous namespace will generate a namespace
+        when compiling, and could generate a different namespace name each time.


s/compiling/compiled/

breakds · 2016-12-17T17:42:40Z

README.md

@@ -129,6 +136,8 @@ See [C++ Programmer's Toolbox](#c-programmers-toolbox) for details.
 1.  **Copy Constructor and Move Constructor**
    *   If you provide copy constructor and/or move constructor,
        provide the corresponding `operator=` overload as well.
+    *   Class should be disable copy/move by default.


I think this statement is too strong. I think for a style guide/primer it is much more valuable if we could explain trade-offs in detail, like what you did for unnamed namespace :)

Copy and move constructors can be very useful, and the programmer should use their best judgement when implementing/disabling them.

breakds · 2016-12-17T17:47:13Z

README.md

-    *   All **references** must be **const**, and this is the recommended
-        way to pass parameters.
-    *   For output parameters, pass pointers.
+    *   Either use const references or pointer for non-fundamental types. The stl types are not fundamental types.


This is mainly for consistency, so that when the reader sees a pointer, he/she realizes that the function works by mutating this argument. Care to share the reasons for rewriting this rule?

breakds · 2016-12-17T17:50:18Z

README.md

 3.  **Trailing Return Type Syntax**
    *   When in lambda. Period.
+    *   When using template, and the output type should be deducted by input types.


s/by/from/

I think this is a good place to have an example :) Our readers may not be equally experienced in C++, and an examples may speak to them better ~

breakds · 2016-12-17T17:55:06Z

README.md

@@ -189,12 +201,14 @@ See [C++ Programmer's Toolbox](#c-programmers-toolbox) for details.
    }
    ```

+    Also we could return a smart pointer for complex type, such as unique_ptr<std::vector<int>>.


In this particular case return unique_ptr<std::vector> is unnecessary and this involves copy elision and/or moving semantics which is the same point as stated in this paragraph :)

It is good, however, to add an example demonstrating returning unique_ptr<SomeType> where SomeType is not movable.

breakds · 2016-12-17T17:56:36Z

README.md

+    better choice for some uses of `const`
+
+
+   * It will let compiler to check whether program is correct or not, rather than die in runtime.


s/to//

I think we need some context on this to make it easier to understand. Care to share a code example?

breakds · 2016-12-17T18:00:05Z

README.md

+
+
+   * It will let compiler to check whether program is correct or not, rather than die in runtime.
+   * Not just for parameter, but also for member function.


So you are talking about the function postfix const here, right? I think this deserves its own article in the cases folder, including the discussion on mutable.

breakds · 2016-12-17T18:00:28Z

README.md

+   * Not just for parameter, but also for member function.
+     * **mutalbe** key word may be used in this situation.
+
+1. Use standard library as much as you can.


breakds · 2016-12-17T18:05:04Z

Sorry I was new to GitHub code review and may have incorrectly disapproved the change ... I think overall it is great just needs some minor change to get rid of the rough edges and maybe adding some more code examples.

Thanks a lot!

breakds

Learned a lot. Thank you, @reyoung !

wangkuiyi · 2016-12-20T18:42:53Z

README.md

+
+    An exception for this rule is:
+
+    * Use a Private Data Class for exposed API, especially for shared library.


@reyoung The [Expose API/Shared Library] is a dangling hyperlink.

wangkuiyi · 2016-12-20T18:44:54Z

README.md

+
+## Shared Library/API
+
+* Please use C-API as the exposed API for most library.


It looks to me that these paragraphs are about C, not part of the C++ Primer. It looks good to me to keep the content in a separate document.

wangkuiyi · 2016-12-20T18:51:35Z

cases/c_api_for_cpp.md

@@ -0,0 +1,41 @@
+In Matrix_API.h


I'd recommend renaming the directory from cases to c-api.

wangkuiyi · 2016-12-20T19:29:27Z