sha512sum/nameof_module
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

clean readme

Browse source
This commit is contained in:
terik23 2019-03-22 00:52:07 +05:00
parent b34459c539
commit 8d49ed040b
1 changed files with 4 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -15,31 +15,25 @@ master |[![Build Status](https://travis-ci.org/Neargye/nameof.svg?branch=master)
## What is Nameof? ## What is Nameof?
A header only C++17 library provides nameof macros and functions to obtain the simple name of a variable, type, member, function, macros and enum. A header only C++17 library provides nameof macros and functions to obtain the simple name of variable, type, function, macros and enum.
Before, you had to use string literals to refer to definitions, which is brittle when renaming code elements because tools do not know to check these string literals. Before, you had to use string literals to refer to definitions, which is brittle when renaming code elements because tools do not know to check these string literals.
## Features ## Features
* C++17 * C++17
* Simple syntax.
* Header-only * Header-only
* Dependency-free * Dependency-free
* Compile-time * Compile-time
* Compilation check
* Name of variable
* Name of member
* Name of function
* Name of emum
* Name of macros
* Name of type
## [Examples](example/example.cpp) ## [Examples](example/example.cpp)
* Name of variable and member * Name of variable
```cpp ```cpp
// Name of variable // Name of variable
NAMEOF(somevar) -> "somevar" NAMEOF(somevar) -> "somevar"
// Name of member // Name of member variable
NAMEOF(person.address.zip_code) -> "zip_code" NAMEOF(person.address.zip_code) -> "zip_code"
constexpr auto cx_name = NAMEOF(somevar); constexpr auto cx_name = NAMEOF(somevar);